mraa  1.7.0
Low Level Skeleton Library for Communication on GNU/Linux platforms
 All Data Structures Namespaces Files Functions Typedefs Enumerations Enumerator Macros Pages
Enumerations
types.h File Reference

API Description

This file defines the basic shared types for libmraa this file is different to common.h in that swig takes this as an input

Go to the source code of this file.

Enumerations

enum  mraa_platform_t {
  MRAA_INTEL_GALILEO_GEN1 = 0, MRAA_INTEL_GALILEO_GEN2 = 1, MRAA_INTEL_EDISON_FAB_C = 2, MRAA_INTEL_DE3815 = 3,
  MRAA_INTEL_MINNOWBOARD_MAX = 4, MRAA_RASPBERRY_PI = 5, MRAA_BEAGLEBONE = 6, MRAA_BANANA = 7,
  MRAA_INTEL_NUC5 = 8, MRAA_96BOARDS = 9, MRAA_INTEL_SOFIA_3GR = 10, MRAA_INTEL_CHERRYHILLS = 11,
  MRAA_UP = 12, MRAA_INTEL_JOULE_EXPANSION = 13, MRAA_PHYBOARD_WEGA = 14, MRAA_DE_NANO_SOC = 15,
  MRAA_FTDI_FT4222 = 256, MRAA_GENERIC_FIRMATA = 1280, MRAA_ANDROID_PERIPHERALMANAGER = 95, MRAA_MOCK_PLATFORM = 96,
  MRAA_JSON_PLATFORM = 97, MRAA_NULL_PLATFORM = 98, MRAA_UNKNOWN_PLATFORM
}
 
enum  mraa_intel_edison_miniboard_t {
  MRAA_INTEL_EDISON_MINIBOARD_J17_1 = 0, MRAA_INTEL_EDISON_MINIBOARD_J17_5 = 4, MRAA_INTEL_EDISON_MINIBOARD_J17_7 = 6, MRAA_INTEL_EDISON_MINIBOARD_J17_8 = 7,
  MRAA_INTEL_EDISON_MINIBOARD_J17_9 = 8, MRAA_INTEL_EDISON_MINIBOARD_J17_10 = 9, MRAA_INTEL_EDISON_MINIBOARD_J17_11 = 10, MRAA_INTEL_EDISON_MINIBOARD_J17_12 = 11,
  MRAA_INTEL_EDISON_MINIBOARD_J17_14 = 13, MRAA_INTEL_EDISON_MINIBOARD_J18_1 = 14, MRAA_INTEL_EDISON_MINIBOARD_J18_2 = 15, MRAA_INTEL_EDISON_MINIBOARD_J18_6 = 19,
  MRAA_INTEL_EDISON_MINIBOARD_J18_7 = 20, MRAA_INTEL_EDISON_MINIBOARD_J18_8 = 21, MRAA_INTEL_EDISON_MINIBOARD_J18_10 = 23, MRAA_INTEL_EDISON_MINIBOARD_J18_11 = 24,
  MRAA_INTEL_EDISON_MINIBOARD_J18_12 = 25, MRAA_INTEL_EDISON_MINIBOARD_J18_13 = 26, MRAA_INTEL_EDISON_MINIBOARD_J19_4 = 31, MRAA_INTEL_EDISON_MINIBOARD_J19_5 = 32,
  MRAA_INTEL_EDISON_MINIBOARD_J19_6 = 33, MRAA_INTEL_EDISON_MINIBOARD_J19_8 = 35, MRAA_INTEL_EDISON_MINIBOARD_J19_9 = 36, MRAA_INTEL_EDISON_MINIBOARD_J19_10 = 37,
  MRAA_INTEL_EDISON_MINIBOARD_J19_11 = 38, MRAA_INTEL_EDISON_MINIBOARD_J19_12 = 39, MRAA_INTEL_EDISON_MINIBOARD_J19_13 = 40, MRAA_INTEL_EDISON_MINIBOARD_J19_14 = 41,
  MRAA_INTEL_EDISON_MINIBOARD_J20_3 = 44, MRAA_INTEL_EDISON_MINIBOARD_J20_4 = 45, MRAA_INTEL_EDISON_MINIBOARD_J20_5 = 46, MRAA_INTEL_EDISON_MINIBOARD_J20_6 = 47,
  MRAA_INTEL_EDISON_MINIBOARD_J20_7 = 48, MRAA_INTEL_EDISON_MINIBOARD_J20_8 = 49, MRAA_INTEL_EDISON_MINIBOARD_J20_9 = 50, MRAA_INTEL_EDISON_MINIBOARD_J20_10 = 51,
  MRAA_INTEL_EDISON_MINIBOARD_J20_11 = 52, MRAA_INTEL_EDISON_MINIBOARD_J20_12 = 53, MRAA_INTEL_EDISON_MINIBOARD_J20_13 = 54, MRAA_INTEL_EDISON_MINIBOARD_J20_14 = 55
}
 
enum  mraa_intel_edison_t {
  MRAA_INTEL_EDISON_GP182 = 0, MRAA_INTEL_EDISON_GP135 = 4, MRAA_INTEL_EDISON_GP27 = 6, MRAA_INTEL_EDISON_GP20 = 7,
  MRAA_INTEL_EDISON_GP28 = 8, MRAA_INTEL_EDISON_GP111 = 0, MRAA_INTEL_EDISON_GP109 = 10, MRAA_INTEL_EDISON_GP115 = 11,
  MRAA_INTEL_EDISON_GP128 = 13, MRAA_INTEL_EDISON_GP13 = 14, MRAA_INTEL_EDISON_GP165 = 15, MRAA_INTEL_EDISON_GP19 = 19,
  MRAA_INTEL_EDISON_GP12 = 20, MRAA_INTEL_EDISON_GP183 = 21, MRAA_INTEL_EDISON_GP110 = 23, MRAA_INTEL_EDISON_GP114 = 24,
  MRAA_INTEL_EDISON_GP129 = 25, MRAA_INTEL_EDISON_GP130 = 26, MRAA_INTEL_EDISON_GP44 = 31, MRAA_INTEL_EDISON_GP46 = 32,
  MRAA_INTEL_EDISON_GP48 = 33, MRAA_INTEL_EDISON_GP131 = 35, MRAA_INTEL_EDISON_GP14 = 36, MRAA_INTEL_EDISON_GP40 = 37,
  MRAA_INTEL_EDISON_GP43 = 38, MRAA_INTEL_EDISON_GP77 = 39, MRAA_INTEL_EDISON_GP82 = 40, MRAA_INTEL_EDISON_GP83 = 41,
  MRAA_INTEL_EDISON_GP134 = 44, MRAA_INTEL_EDISON_GP45 = 45, MRAA_INTEL_EDISON_GP47 = 46, MRAA_INTEL_EDISON_GP49 = 47,
  MRAA_INTEL_EDISON_GP15 = 48, MRAA_INTEL_EDISON_GP84 = 49, MRAA_INTEL_EDISON_GP42 = 50, MRAA_INTEL_EDISON_GP41 = 51,
  MRAA_INTEL_EDISON_GP78 = 52, MRAA_INTEL_EDISON_GP79 = 53, MRAA_INTEL_EDISON_GP80 = 54, MRAA_INTEL_EDISON_GP81 = 55
}
 
enum  mraa_raspberry_wiring_t {
  MRAA_RASPBERRY_WIRING_PIN8 = 3, MRAA_RASPBERRY_WIRING_PIN9 = 5, MRAA_RASPBERRY_WIRING_PIN7 = 7, MRAA_RASPBERRY_WIRING_PIN15 = 8,
  MRAA_RASPBERRY_WIRING_PIN16 = 10, MRAA_RASPBERRY_WIRING_PIN0 = 11, MRAA_RASPBERRY_WIRING_PIN1 = 12, MRAA_RASPBERRY_WIRING_PIN2 = 13,
  MRAA_RASPBERRY_WIRING_PIN3 = 15, MRAA_RASPBERRY_WIRING_PIN4 = 16, MRAA_RASPBERRY_WIRING_PIN5 = 18, MRAA_RASPBERRY_WIRING_PIN12 = 19,
  MRAA_RASPBERRY_WIRING_PIN13 = 21, MRAA_RASPBERRY_WIRING_PIN6 = 22, MRAA_RASPBERRY_WIRING_PIN14 = 23, MRAA_RASPBERRY_WIRING_PIN10 = 24,
  MRAA_RASPBERRY_WIRING_PIN11 = 26, MRAA_RASPBERRY_WIRING_PIN17 = 29, MRAA_RASPBERRY_WIRING_PIN21 = 29, MRAA_RASPBERRY_WIRING_PIN18 = 30,
  MRAA_RASPBERRY_WIRING_PIN19 = 31, MRAA_RASPBERRY_WIRING_PIN22 = 31, MRAA_RASPBERRY_WIRING_PIN20 = 32, MRAA_RASPBERRY_WIRING_PIN26 = 32,
  MRAA_RASPBERRY_WIRING_PIN23 = 33, MRAA_RASPBERRY_WIRING_PIN24 = 35, MRAA_RASPBERRY_WIRING_PIN27 = 36, MRAA_RASPBERRY_WIRING_PIN25 = 37,
  MRAA_RASPBERRY_WIRING_PIN28 = 38, MRAA_RASPBERRY_WIRING_PIN29 = 40
}
 
enum  mraa_result_t {
  MRAA_SUCCESS = 0, MRAA_ERROR_FEATURE_NOT_IMPLEMENTED = 1, MRAA_ERROR_FEATURE_NOT_SUPPORTED = 2, MRAA_ERROR_INVALID_VERBOSITY_LEVEL = 3,
  MRAA_ERROR_INVALID_PARAMETER = 4, MRAA_ERROR_INVALID_HANDLE = 5, MRAA_ERROR_NO_RESOURCES = 6, MRAA_ERROR_INVALID_RESOURCE = 7,
  MRAA_ERROR_INVALID_QUEUE_TYPE = 8, MRAA_ERROR_NO_DATA_AVAILABLE = 9, MRAA_ERROR_INVALID_PLATFORM = 10, MRAA_ERROR_PLATFORM_NOT_INITIALISED = 11,
  MRAA_ERROR_UART_OW_SHORTED = 12, MRAA_ERROR_UART_OW_NO_DEVICES = 13, MRAA_ERROR_UART_OW_DATA_ERROR = 14, MRAA_ERROR_UNSPECIFIED = 99
}
 
enum  mraa_pinmodes_t {
  MRAA_PIN_VALID = 0, MRAA_PIN_GPIO = 1, MRAA_PIN_PWM = 2, MRAA_PIN_FAST_GPIO = 3,
  MRAA_PIN_SPI = 4, MRAA_PIN_I2C = 5, MRAA_PIN_AIO = 6, MRAA_PIN_UART = 7
}
 
enum  mraa_i2c_mode_t { MRAA_I2C_STD = 0, MRAA_I2C_FAST = 1, MRAA_I2C_HIGH = 2 }
 
enum  mraa_uart_parity_t {
  MRAA_UART_PARITY_NONE = 0, MRAA_UART_PARITY_EVEN = 1, MRAA_UART_PARITY_ODD = 2, MRAA_UART_PARITY_MARK = 3,
  MRAA_UART_PARITY_SPACE = 4
}
 

Enumeration Type Documentation

MRAA supported platform types

Enumerator
MRAA_INTEL_GALILEO_GEN1 

The Generation 1 Galileo platform (RevD)

MRAA_INTEL_GALILEO_GEN2 

The Generation 2 Galileo platform (RevG/H)

MRAA_INTEL_EDISON_FAB_C 

The Intel Edison (FAB C)

MRAA_INTEL_DE3815 

The Intel DE3815 Baytrail NUC

MRAA_INTEL_MINNOWBOARD_MAX 

The Intel Minnow Board Max

MRAA_RASPBERRY_PI 

The different Raspberry PI Models -like A,B,A+,B+

MRAA_BEAGLEBONE 

The different BeagleBone Black Modes B/C

MRAA_BANANA 

Allwinner A20 based Banana Pi and Banana Pro

MRAA_INTEL_NUC5 

The Intel 5th generations Broadwell NUCs

MRAA_96BOARDS 

Linaro 96boards

MRAA_INTEL_SOFIA_3GR 

The Intel SoFIA 3GR

MRAA_INTEL_CHERRYHILLS 

The Intel Braswell Cherryhills

MRAA_UP 

The UP Board

MRAA_INTEL_JOULE_EXPANSION 

The Intel Joule Expansion Board

MRAA_PHYBOARD_WEGA 

The phyBOARD-Wega

MRAA_DE_NANO_SOC 

Terasic DE-Nano-SoC Board

MRAA_FTDI_FT4222 

FTDI FT4222 USB to i2c bridge

MRAA_GENERIC_FIRMATA 

Firmata uart platform/bridge

MRAA_ANDROID_PERIPHERALMANAGER 

Android Things peripheral manager platform

MRAA_MOCK_PLATFORM 

Mock platform, which requires no real hardware

MRAA_JSON_PLATFORM 

User initialised platform from json

MRAA_NULL_PLATFORM 

Platform with no capabilities that hosts a sub platform

MRAA_UNKNOWN_PLATFORM 

An unknown platform type, typically will load INTEL_GALILEO_GEN1

Intel edison miniboard numbering enum

Intel Edison raw GPIO numbering enum

Raspberry PI Wiring compatible numbering enum

MRAA return codes

Enumerator
MRAA_SUCCESS 

Expected response

MRAA_ERROR_FEATURE_NOT_IMPLEMENTED 

Feature TODO

MRAA_ERROR_FEATURE_NOT_SUPPORTED 

Feature not supported by HW

MRAA_ERROR_INVALID_VERBOSITY_LEVEL 

Verbosity level wrong

MRAA_ERROR_INVALID_PARAMETER 

Parameter invalid

MRAA_ERROR_INVALID_HANDLE 

Handle invalid

MRAA_ERROR_NO_RESOURCES 

No resource of that type avail

MRAA_ERROR_INVALID_RESOURCE 

Resource invalid

MRAA_ERROR_INVALID_QUEUE_TYPE 

Queue type incorrect

MRAA_ERROR_NO_DATA_AVAILABLE 

No data available

MRAA_ERROR_INVALID_PLATFORM 

Platform not recognised

MRAA_ERROR_PLATFORM_NOT_INITIALISED 

Board information not initialised

MRAA_ERROR_UART_OW_SHORTED 

UART OW Short Circuit Detected

MRAA_ERROR_UART_OW_NO_DEVICES 

UART OW No devices detected

MRAA_ERROR_UART_OW_DATA_ERROR 

UART OW Data/Bus error detected

MRAA_ERROR_UNSPECIFIED 

Unknown Error

Enum representing different possible modes for a pin.

Enumerator
MRAA_PIN_VALID 

Pin Valid

MRAA_PIN_GPIO 

General Purpose IO

MRAA_PIN_PWM 

Pulse Width Modulation

MRAA_PIN_FAST_GPIO 

Faster GPIO

MRAA_PIN_SPI 

SPI

MRAA_PIN_I2C 

I2C

MRAA_PIN_AIO 

Analog in

MRAA_PIN_UART 

UART

Enum reprensenting different i2c speeds/modes

Enumerator
MRAA_I2C_STD 

up to 100Khz

MRAA_I2C_FAST 

up to 400Khz

MRAA_I2C_HIGH 

up to 3.4Mhz