API Constants

KETCube Arduino API Constants. More...

Enumerations
enum	bool_t {   TRUE = 1 ,   FALSE = 0 }
	digital PIN value More...
enum	ketCube_Arduino_pin_t {   IO1 ,   IO2 ,   IO3 ,   IO4 ,   AN ,   RST ,   CS ,   SCK ,   MISO ,   MOSI ,   PWM ,   INT ,   RX ,   TX ,   SCL ,   SDA ,   LED1 ,   LED2 }
	Arduino PIN definition. More...
enum	ketCube_Arduino_pinMode_t {   ANALOG = 0x00 ,   INPUT = 0x01 ,   OUTPUT = 0x02 ,   IT_RISING = 0x03 ,   IT_FALLING = 0x04 ,   IT_CHANGE = 0x05 ,   INPUT_PULLUP = 0x10 ,   INPUT_PULLDOWN = 0x20 }
	digital PIN mode More...
enum	ketCube_Arduino_pinValue_t {   HIGH = TRUE ,   LOW = FALSE }
	digital PIN value More...
enum	ketCube_Arduino_ledFunction_t {   LED_OFF = 0 ,   LED_ON ,   LED_BLINK_SINGLE ,   LED_BLINK_CONT }
	LED functions. More...
enum	ketCube_Arduino_LPWANLimits_t { LPWAN_MAX_BYTES = 10 }
	LPWAN limits. More...
enum	ketCube_Arduino_parity_t {   PARITY_NONE = 0 ,   PARITY_ODD = 1 ,   PARITY_EVEN = 2 }
	UART parity. More...

Detailed Description

KETCube Arduino API Constants.

Enumeration Type Documentation

bool_t

enum bool_t

digital PIN value

Enumerator
TRUE	TRUE value.
FALSE	FALSE value.

ketCube_Arduino_ledFunction_t

enum ketCube_Arduino_ledFunction_t

LED functions.

Enumerator
LED_OFF	LED is permanently OFF
LED_ON	LED is permanently ON.
LED_BLINK_SINGLE	LED BLINKs - single flash.
LED_BLINK_CONT	LED BLINKs - continuous flashing.

ketCube_Arduino_LPWANLimits_t

enum ketCube_Arduino_LPWANLimits_t

LPWAN limits.

Enumerator
LPWAN_MAX_BYTES	LPWAN is limited to 10 bytes.

ketCube_Arduino_parity_t

enum ketCube_Arduino_parity_t

UART parity.

Enumerator
PARITY_NONE	NO parity.
PARITY_ODD	ODD parity.
PARITY_EVEN	EVEN parity.

ketCube_Arduino_pin_t

enum ketCube_Arduino_pin_t

Arduino PIN definition.

Enumerator
IO1	KETCube PIN IO1.
IO2	KETCube PIN IO2.
IO3	KETCube PIN IO3.
IO4	KETCube PIN IO4.
AN	KETCube PIN AN; this pin has ADC capability; this pin has DAC capability.
RST	KETCube PIN RST; this pin has ADC capability.
CS	KETCube PIN CS
SCK	KETCube PIN SCK.
MISO	KETCube PIN MISO.
MOSI	KETCube PIN MOSI.
PWM	KETCube PIN PWM.
INT	KETCube PIN INT.
RX	KETCube PIN RX; this pin has ADC capability
TX	KETCube PIN TX; this pin has ADC capability
SCL	KETCube PIN SCL.
SDA	KETCube PIN SDA.
LED1	KETCube PIN LED1.
LED2	KETCube PIN LED2.

ketCube_Arduino_pinMode_t

enum ketCube_Arduino_pinMode_t

digital PIN mode

Enumerator
ANALOG	PIN mode ANALOG.
INPUT	PIN mode INPUT.
OUTPUT	PIN mode OUTPUT.
IT_RISING	trigger when the pin goes to high
IT_FALLING	trigger when the pin goes to low
IT_CHANGE	trigger the interrupt whenever the pin changes value
INPUT_PULLUP	PIN mode INPUT with PULL UP.
INPUT_PULLDOWN	PIN mode INPUT with PULL DOWN.

ketCube_Arduino_pinValue_t

enum ketCube_Arduino_pinValue_t

digital PIN value

Enumerator
HIGH	PIN value HIGH.
LOW	PIN value LOW.