EDU Arduino API Documentation

The KETCube EDU package for Arduino offers the API following the Arduino Language structure.

We provide equivalents for a subset of functions defined by the Arduino Language,
where KETCube EDU API functions are called using the KETCube API object and the "dot" convention.

Additionally, we provide function groups defined exclusively for KETCube.

Note

KETCube EDU API function is invoked as follows: KETCube.GROUP.NAME(),
where GROUP is the function group,
and NAME is the function name.

If you need a function not provided by the KETCube EDU API, see the functions in the standard C library.

Note

KETCube EDU is compiled exclusively by the GCC compiler.
The provided programing interface conforms with the ISO C99 GNU dialect (C99 including some C11 features).

Functions

Digital IO

• pinMode()
• digitalRead()
• digitalWrite()
• attachInterrupt()

Function call example: KETCube.IO.pinMode(IO1, INPUT);

Analog

• init()
• read()
• write()

Function call example: KETCube.Analog.read(AN);

PWM

• init()
• tone()

Function call example: KETCube.PWM.tone(PWM);

LED driver

• init()
• set()

Function call example: KETCube.LED.init(IO1, ON);

KETCube Terminal

• print()
• printError()
• printInfo()
• printDebug()

Function call example: KETCube.Terminal.print("Hello world!");

KETCube Time

• delay()
• delayMicroseconds()
• micros()
• millis()
• wakeAfter()
• wakeIntervalElapsed()

Function call example: KETCube.Time.delay(10);

KETCube LPWAN

• send()
• regOnRxHandler()

Function call example: KETCube.LPWAN.send(buffer, 5);

KETCube I2C

• init()
• read()
• write()

Function call example: KETCube.I2C.write((0x76 << 1), &buffer, 2);

KETCube UART

• init()
• send()
• receive()

Function call example: KETCube.UART.send((uint8_t *) &(buffer[0]), strlen(&(buffer[0])), TIMEOUT);

KETCube Core

• regSleepExitHandler()

Function call example: KETCube.Core.regSleepExitHandler(&onExitHandler);

Variables

Constants

• Boolean: TRUE | FALSE
• PIN Mode: ANALOG | INPUT | OUTPUT | IT_RISING | IT_FALLING | IT_CHANGE | INPUT_PULLUP | INPUT_PULLDOWN
• PIN Value: HIGH | LOW
• LED Function: LED_OFF | LED_ON | LED_BLINK_SINGLE | LED_BLINK_CONT
• LPWAN Limits: LPWAN_MAX_BYTES
• UART Parity: PARITY_NONE | PARITY_ODD | PARITY_EVEN

KETCube Pinout

• IO1 | IO2 | IO3 | IO4 | AN | RST | CS | SCK | MISO | MOSI | PWM | INT | RX | TX | SCL | SDA | LED1 | LED2