-
Notifications
You must be signed in to change notification settings - Fork 2
UPER function list
Below is a list of implemented functions and their descriptions. SFP function names are case sensitive. Function IDs (decimal values) are given in the brackets next to every function.
Configures pin pinID to primary or secondary function. Secondary pin function should be enabled before calling any of the secondary functions (e.g. analog, pwm, spi, i2c).
Parameters: int pinID - pin number (0-33)
By default GPIO is always the primary function. Some pins don't have secondary functions - that is their secondary function is also GPIO. Secondary pin functions are shown in the table below.
| pinID | LPC pin | Secondary function |
|---|---|---|
| 0 | PIO0_20 | GPIO |
| 1 | PIO0_2 | GPIO |
| 2 | PIO1_26 | PWM1_2 |
| 3 | PIO1_27 | GPIO |
| 4 | PIO1_20 | SPI1 SCK |
| 5 | PIO0_21 | SPI1 MOSI |
| 6 | PIO1_23 | GPIO |
| 7 | PIO1_24 | PWM1_0 |
| 8 | PIO0_7 | GPIO |
| 9 | PIO1_28 | GPIO |
| 10 | PIO1_31 | GPIO |
| 11 | PIO1_21 | SPI1 MISO |
| 12 | PIO0_8 | SPI0 MISO |
| 13 | PIO0_9 | SPI0 MOSI |
| 14 | PIO0_10 | SPI0 SCK |
| 15 | PIO1_29 | GPIO |
| 16 | PIO1_19 | GPIO |
| 17 | PIO1_25 | PWM1_1 |
| 18 | PIO1_16 | GPIO |
| 19 | PIO0_19 | UART TX |
| 20 | PIO0_18 | UART RX |
| 21 | PIO0_17 | GPIO |
| 22 | PIO1_15 | PWM0_2 |
| 23 | PIO0_23 | ADC7 |
| 24 | PIO0_22 | ADC6 |
| 25 | PIO0_16 | ADC5 |
| 26 | PIO0_15 | ADC4 |
| 27 | PIO1_22 | GPIO |
| 28 | PIO1_14 | PWM0_1 |
| 29 | PIO1_13 | PWM0_0 |
| 30 | PIO0_14 | ADC3 |
| 31 | PIO0_13 | ADC2 |
| 32 | PIO0_12 | ADC1 |
| 33 | PIO0_11 | ADC0 |
Configures GPIO pin mode. Pin should be set to GPIO function before configuring its GPIO mode.
Parameters:
int pinID - pin number (0-33)
int pinMode - pin mode: 0 - input (high Z), 1 - output, 2 - input (pull down), 4 - input (pull up)
Sets GPIO output high or low.
Parameters:
int pinID - pin number (0-33)
int value - digital output value: 0 - LOW, 1 - HIGH
Reads digital state of the GPIO pin.
Parameters:
int pinID - pin number (0-33)
Returns message digitalRead(int pinID, int value) [05], where the value is 0 (LOW state) or 1 (HIGH state)
Attaches GPIO interrupt service to the specified pin. There is a total of 8 interrupts which can be attached to any pin. Interrupts can be configured to trigger at HIGH or LOW state or at RISING, FALLING or both edges. When the interrupt is triggered, device sends message interrupt(int interruptID, int event) [8], where event has the same meaning as mode.
Parameters:
int interruptID - interrupt number (0-7)
int pinID - pin number (0-33)
int mode - interrupt trigger mode: 0-LEVEL LOW, 1-LEVEL HIGH, 2-EDGE CHANGE, 3-EDGE RISE, 4-EDGE FALL.
Detaches (disables) specified GPIO interrupt.
Parameters:
int interruptID - interrupt number (0-7)
Parameters:
int analogPinID - analog pin number (0-7), corresponds to ADC0-ADC7 pins.
Returns message analogRead(int analogPinID, int value) [10], where value is 10 bit ADC read value.
Measures pulse duration on a pin. Is compatible with Arduino command pulseIn (http://arduino.cc/en/Reference/PulseIn).
Parameters:
int pinID - pin number (0-33)
int level - level of the pulse (0 - LOW level, 1 - HIGH)
int timeout - number of microseconds to wait until timeout
Returns message pulseIn(int pulseWidth) [09], where the pulseWidth is 0 if no pulse was detected during timeout period or pulse duration in microseconds.
Enables and configures PWM module. Each PWM module has 3 channels. PWM signal period (and frequency) is the same for all channels in one PWM module, but the signal high time (and duty cycle) can be different. PWM channels that are in the same module are synchronized.
Parameters:
int period - PWM signal period in microseconds. 16 bit value (1-65536) for PWM0 and 32bit value for PWM1.
Sets the high time of the PWM channel.
Parameters:
int channel - PWM channel number (0-2)
int high_time - PWM signal high time in microseconds. 16 bit value (0-65535) for PWM0 and 32bit value for PWM1. This value should be less than PWM period or undefined behavior might occur.
Stops the PWM module.
Starts and configures SPI module. This function configure device to master mode. Slave mode is not supported.
Parameters:
int divider - SCK signal frequency divider value (1-256). The primary SCK signal frequency is 2MHz.
int mode - standart SPI mode number (0-3) which determines clock polarity and phase (http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus#Mode_numbers)
Executes SPI transaction. User should manually (using GPIO functions) drive slave select line low when executing the transaction. Depending on respond value, the device can send back the data that it received from the slave by sending message spi0_trans(byte[] slaveData) [21].
Parameters:
byte[] data - bytes which will be sent to the slave.
int respond - value which tells if device should send back slave data: 0 - do not send, 1 - send back slave data.
Disables the SPI module.
Initializes I2C module.
Executes I2C MASTER WRITE and MASTER READ transactions. The data received during MASTER READ transaction is sent back to the host via i2c_trans(int address, byte[] receivedData) message. If error occurs during transactions i2c_trans(int address, int errorCode) [41] is sent back to the host.
Parameters:
int address - slave device address.
byte[] writeData - byte array which will be sent to the slave during MASTER WRITE. If blob size is 0 MASTER WRITE transaction is skipped.
int readLength - number of bytes to read during MASTER READ transaction. If readLength is 0 MASTER READ transaction is not executed.
Disables I2C module.
Writes a value directly to the device register located at registerAddress.
Reads a register value. Responds with registerRead(int registerAddress, int registerValue) [101] message.
Returns device information. Responds with GetDeviceInfo(int firmwareVersion, byte[] UID, int lpcPartNumber, int lpcBootCodeVersion) [255] message.
int firmwareVersion - [31:24] bits are device (firmware) type and is 0x55 (ASCII 'U') for UPER board, [23:16] bits are firmware major version and [15:0] bits are firmware minor version.
byte[] UID - 16 byte long Unique IDentifier, which is read from the host device (LPC microcontroller).
int lpcPartNumber - device part number which is read from the host device (LPC microcontroller).
int lpcBootCodeVersion - device bootload code version which is read from the host device (LPC microcontroller).