Difference between revisions of "Component: API (ECIO28P) (API Slave Devices)"

Revision as of 12:00, 3 February 2023

Author	Matrix TSL
Version	2.0
Category	API Slave Devices

API (ECIO28P) component

Connects to an ECIO28P running the API Firmware allowing the board to become a slave to the Flowcode Embedded simulation or Flowcode App Developer. Supports: Digital IO / ADC / I2C / SPI / PWM / UART See Flowcode Help Wiki for firmware.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/ECIO28P_API_Comp.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/ECIO28P_API_Comp.fcfx

Detailed description

The App Developer (ECIO28P) component allows an ECIO28P board to be controlled from within the Flowcode simulation runtime.

To allow Flowcode to communicate and control the ECIO28P hardware the board must first be pre-programmed with dedicated firmware.

The firmware hex file and Flowcode source project can be downloaded from here.

ECIO28P App Developer Firmware

More information about the workings of the firmware project can be found on the FiniteStateMachine page.

The COM port to the ECIO hardware is selected via the SCADA_ECIO28P component COM port property.

When building the component into a App Developer project remember to expose the COM port property to allow the end user to select the correct port for the hardware.

The console window can display data in two modes which is set via a component property.

fixed statistics showing IO / ADC inputs / PWM
scrolling log showing all commands and returns

Examples

Pin Mapping

Here is a table showing how the App Developer Slave digital pins are mapped on the device.

App Developer Slave Digital Pin	0	1	2	3	4	5	6	7	8	9	10	11	12	13	14	15	16	17	18
Device Port Pin	A0	A1	A2	A3	A4	A5	B0	B1	B2	B3	B4	B5	B6	B7	C0	C1	C2	C6	C7

Here is a table showing how the App Developer Slave analogue pins are mapped on the device.

App Developer Slave Analogue Pin	0	1	2	3	4	5	6	7	8	9	10	11	12
Device Port Pin	A0	A1	A2	A3	A5				B2	B3	B1	B4	B0

Here is a table showing how the App Developer Slave peripheral pins are mapped on the device.

App Developer Slave Peripheral Pin	I2C SDA	I2C SCL	SPI MOSI	SPI MISO	SPI SCK	UART RX	UART TX	PWM 0	PWM 1
Device Port Pin	B0	B1	C7	B0	B1	C7	C6	C2	C1

Direct Slave Access

Here is a simple demo to switch on and off digital pin 5 (the LED pin).

ECIO28P App Developer Example

Rapid Development - Virtualised SPI

A feature of the App Developer Slave interface is to use the component for rapid development.

The App Developer Slave hardware can be used to take communications from the Flowcode simulation and transfer them to a real world device allowing for easy code generation and test without having to download to a target microcontroller device.

The CS pin and SPI Prescaler are set via the properties of the Injector component.

The SPI Master component is linked to the Injector component via the Injector property.

The Injector component is linked to the App Developer Slave component via the App Developer Slave property.

ECIO App Developer Slave SPI Demo

Rapid Development - Virtualised I2C

A feature of the App Developer Slave interface is to use the component for rapid development.

The App Developer Slave hardware can be used to take communications from the Flowcode simulation and transfer them to a real world device allowing for easy code generation and test without having to download to a target microcontroller device.

The I2C Master component is linked to the Injector component via the Injector property.

The Injector component is linked to the App Developer Slave component via the App Developer Slave property.

ECIO App Developer Slave I2C Demo

Rapid Development - Virtualised UART

A feature of the App Developer Slave interface is to use the component for rapid development.

The App Developer Slave hardware can be used to take communications from the Flowcode simulation and transfer them to a real world device allowing for easy code generation and test without having to download to a target microcontroller device.

The Baud rate and optional RS485 Properties are set via the properties of the Injector component.

The UART component is linked to the Injector component via the Injector property.

The Injector component is linked to the App Developer Slave component via the App Developer Slave property.

ECIO App Developer Slave UART Demo

Macro reference

ADCSample10

	ADCSample10
Reads the voltage present on an Alanog pin as an 10-bit value range 0-1023
- BYTE	ADCChannel
Range: 0-12
- UINT	Return

ADCSample8

	ADCSample8
Reads the voltage present on an Alanog pin as an 8-bit value range 0-255
- BYTE	ADCChannel
Range: 0-12
- BYTE	Return

ADCSampleArray10

	ADCSampleArray10
Reads the voltage present on an Analog pin as an 10-bit value range 0-1023 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet
- BYTE	ADCChannel
Range: 0-5
- BYTE	SampleCount
Range: 1- 32
- UINT	SampleDelay
Delay in us between each sample
- UINT	Samples
10-bit samples returned from the function
- VOID	Return

ADCSampleArray8

	ADCSampleArray8
Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet
- BYTE	ADCChannel
Range: 0-5
- BYTE	SampleCount
Range: 1- 32
- UINT	SampleDelay
Delay in us between each sample
- BYTE	Samples
8-bit samples returned from the function
- VOID	Return

ADCSampleAverage10

	ADCSampleAverage10
Reads the voltage present on an Analog pin as an 10-bit value range 0-1023. Performs the selected number of samples with the selected time in microseconds in between samples
- BYTE	ADCChannel
Range: 0-5
- BYTE	SampleCount
Range: 1- 100
- BYTE	SampleDelay
Delay in us between each sample
- UINT	Return

ADCSampleAverage8

	ADCSampleAverage8
Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples
- BYTE	ADCChannel
Range: 0-5
- BYTE	SampleCount
Range: 1- 100
- BYTE	SampleDelay
Delay in us between each sample
- BYTE	Return

ADCSetPrechargeTime

	ADCSetPrechargeTime
Specifies the precharge time for the ADC input readings in microseconds. The longer the time the more immune to noise the reading will be.
- BYTE	ChargeTime
Default 10
- VOID	Return

ADCSetReferenceVoltage

	ADCSetReferenceVoltage
Specified the reference setting for ADC reads.
- BYTE	RefType
0=AREF, 1=VCC, 3=Internal 1.1V
- VOID	Return

I2CInitialise

	I2CInitialise
Initialsie the I2C module ready for communications
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Baud
0=100KHz, 1=400KHz, 2=1MHz
- VOID	Return

I2CReceive

	I2CReceive
Receive a byte using the I2C bus
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BOOL	Last
Last byte to receive: Range 0-1
- BYTE	Return

I2CRestart

	I2CRestart
Put the I2C Module into Restart mode
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

I2CSend

	I2CSend
Transmit a byte using the I2C bus
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	DataOut

- BOOL	Return

I2CStart

	I2CStart
Put the I2C Module into Start mode
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- VOID	Return

I2CStop

	I2CStop
Put the I2C Module into Stop mode
- BYTE	Channel

- VOID	Return

I2CTransInit

	I2CTransInit
Initialises the I2C Transaction mode with the 7-bit device address
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	DeviceAddress
7-bit Device Address
- BYTE	Baud
0=100KHz, 1=400KHz, 2=1MHz
- VOID	Return

I2CTransReceive

	I2CTransReceive
Receives an I2C Transaction on the selected I2C channel. Returns the number of bytes received.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Data
Data variable to receive into
- UINT	Count
Number of bytes to receive
- UINT	Return

I2CTransSend

	I2CTransSend
Sends an I2C Transaction on the selected I2C channel. Returns the number of bytes sent.
- BYTE	Channel
Channel Index: Range 0 - I2C Bus Count - 1
- BYTE	Data
Data to send
- UINT	Count
Number of bytes to send out, MS bit 0x8000 signifies no Stop if set
- UINT	Return

IOGetInputPin

	IOGetInputPin
Sets the selected digital pin to an input and reads the input state.
- BYTE	Pin
Range: 0-18
- BOOL	Return

IOSetOutputPin

	IOSetOutputPin
Sets the selected digital pin to an output and assigns the output state.
- BYTE	Pin
Range: 0-18
- BOOL	State
Range: 0-1
- VOID	Return

Initialise

	Initialise
Initialise the comms to the Arduino board ready for commands to be sent.
- VOID	Return

PWMDisable

	PWMDisable
Disable a PWM output
- BYTE	Channel
Range: 0-1
- VOID	Return

PWMEnable

	PWMEnable
Enable a PWM output
- BYTE	Channel
Range: 0-1
- VOID	Return

PWMSetDuty

	PWMSetDuty
Sets the duty for the PWM output
- BYTE	Channel
Range: 0-5
- BYTE	Duty

- VOID	Return

PWMSetPrescaler

	PWMSetPrescaler
Sets the prescaler for the PWM output
- BYTE	Channel

- BYTE	Prescaler

- BYTE	Period
Default 255
- VOID	Return

RegisterRead

	RegisterRead
Read one of the registers on-board the device
- UINT	RegisterAddress
The address of the register
- BYTE	Return

RegisterWrite

	RegisterWrite
Writes to one of the registers on-board the device
- UINT	RegisterAddress
The address of the register
- BYTE	Data
The data value to assign to the register
- VOID	Return

SPIInitialise

	SPIInitialise
Initialsie the SPI module ready for communications
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- VOID	Return

SPIPrescaler

	SPIPrescaler
Modify the speed of the SPI bus
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- BYTE	Prescaler
Range: 0-2
- VOID	Return

SPITransfer

	SPITransfer
Transfer a byte using the SPI bus
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- BYTE	DataOut

- BYTE	Return

SPITransferTrans

	SPITransferTrans
Transfer an array of bytes using the SPI bus
- BYTE	Channel
Channel Index: Range 0 - SPI Bus Count - 1
- UINT	Count
Number of bytes to send and receive
- BYTE	DataOut
Outgoing data
- BYTE	DataIn
Incoming data
- VOID	Return

UARTBaud

	UARTBaud
Control the communications rate of the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Rate
0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200
- VOID	Return

UARTCheckRX

	UARTCheckRX
Check to see if the UART module has received any data
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

UARTInitialise

	UARTInitialise
Initialise the UART module ready for communications
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- VOID	Return

UARTReceive

	UARTReceive
Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Return

UARTSend

	UARTSend
Send a byte via the UART module
- BYTE	Channel
Channel Index: Range 0 - UART Bus Count - 1
- BYTE	Data
Data Byte to send. Range: 0-255
- VOID	Return

Property reference

	Properties
	Connection
	Auto Detect Port

	COM Port
Lists all the current available COM port hardware on your PC.
	Refresh Ports

	API Peripherals
	Digital IO

	Analog Input

	Analog Output

	PWM Output

	I2C Bus

	SPI Bus

	UART

	SERVO

	Console
	Console Log
Create an automatic console log of the commands sent to the Arduino
	Log Mode
Controls how the console data is formatted. Fixed statistics gives an easy to read overview of the IO, Analog and PWM functionality Command Log gives a more in depth analysis of the outgoing commands and incoming returns ASCII mode allows serial data to be shown in raw text form, other commands are shown as in the Command Log mode

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ECIO28P_API_Comp.fcfx FC_Comp_Source_ECIO28P_API_Comp.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/ECIO28P_API_Comp.fcfx FC_Comp_Source_temp/ECIO28P_API_Comp.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ECIO28P_API_Comp.fcfx FC_Comp_Source_ECIO28P_API_Comp.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/ECIO28P_API_Comp.fcfx FC_Comp_Source_temp/ECIO28P_API_Comp.fcfx]
 ==Detailed description==
@@ Line 257: / Line 257: @@
 {{Fcfile|ECIO_SCADASlave_UART.fcfx|ECIO App Developer Slave UART Demo}}
@@ Line 264: / Line 266: @@
 ==Macro reference==
-===I2CInitialise===
+===ADCSample10===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CInitialise'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSample10'''
 |-
-| colspan="2" | Initialsie the I2C module ready for communications&nbsp;
+| colspan="2" | Reads the voltage present on an Alanog pin as an 10-bit value range 0-1023&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
+| width="90%" | ADCChannel
+|-
+| colspan="2" | Range: 0-12&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===ADCSample8===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSample8'''
+|-
+| colspan="2" | Reads the voltage present on an Alanog pin as an 8-bit value range 0-255&nbsp;
 |-
-| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Baud
+| width="90%" | ADCChannel
 |-
-| colspan="2" | 0=100KHz, 1=400KHz, 2=1MHz&nbsp;
+| colspan="2" | Range: 0-12&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===ADCSampleArray8===
+===ADCSampleArray10===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSampleArray8'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSampleArray10'''
 |-
-| colspan="2" | Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet&nbsp;
+| colspan="2" | Reads the voltage present on an Analog pin as an 10-bit value range 0-1023 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet&nbsp;
 |-
 |-
@@ Line 312: / Line 328: @@
 | colspan="2" | Delay in us between each sample&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" | Samples
 |-
-| colspan="2" | 8-bit samples returned from the function&nbsp;
+| colspan="2" | 10-bit samples returned from the function&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 322: / Line 338: @@
-===SPITransferTrans===
+===ADCSampleArray8===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPITransferTrans'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSampleArray8'''
 |-
-| colspan="2" | Transfer an array of bytes using the SPI bus&nbsp;
+| colspan="2" | Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
+| width="90%" | ADCChannel
 |-
-| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
+| colspan="2" | Range: 0-5&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Count
+| width="90%" | SampleCount
 |-
-| colspan="2" | Number of bytes to send and receive&nbsp;
+| colspan="2" | Range: 1- 32&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | DataOut
+| width="90%" | SampleDelay
 |-
-| colspan="2" | Outgoing data&nbsp;
+| colspan="2" | Delay in us between each sample&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | DataIn
+| width="90%" | Samples
 |-
-| colspan="2" | Incoming data&nbsp;
+| colspan="2" | 8-bit samples returned from the function&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 356: / Line 372: @@
-===IOGetInputPin===
+===ADCSampleAverage10===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IOGetInputPin'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSampleAverage10'''
 |-
-| colspan="2" | Sets the selected digital pin to an input and reads the input state.&nbsp;
+| colspan="2" | Reads the voltage present on an Analog pin as an 10-bit value range 0-1023. Performs the selected number of samples with the selected time in microseconds in between samples&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Pin
+| width="90%" | ADCChannel
-|-
-| colspan="2" | Range: 0-18&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-===UARTBaud===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTBaud'''
-|-
-| colspan="2" | Control the communications rate of the UART module&nbsp;
 |-
+| colspan="2" | Range: 0-5&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
+| width="90%" | SampleCount
 |-
-| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
+| colspan="2" | Range: 1- 100&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Rate
+| width="90%" | SampleDelay
 |-
-| colspan="2" | 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200&nbsp;
+| colspan="2" | Delay in us between each sample&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===ADCSample8===
+===ADCSampleAverage8===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSample8'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSampleAverage8'''
 |-
-| colspan="2" | Reads the voltage present on an Alanog pin as an 8-bit value range 0-255&nbsp;
+| colspan="2" | Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples&nbsp;
 |-
 |-
@@ Line 411: / Line 413: @@
 | width="90%" | ADCChannel
 |-
-| colspan="2" | Range: 0-12&nbsp;
+| colspan="2" | Range: 0-5&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-===I2CTransReceive===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CTransReceive'''
-|-
-| colspan="2" | Receives an I2C Transaction on the selected I2C channel. Returns the number of bytes received.&nbsp;
-|-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
+| width="90%" | SampleCount
 |-
-| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
+| colspan="2" | Range: 1- 100&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Data
+| width="90%" | SampleDelay
 |-
-| colspan="2" | Data variable to receive into&nbsp;
+| colspan="2" | Delay in us between each sample&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Count
-|-
-| colspan="2" | Number of bytes to receive&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===UARTInitialise===
+===ADCSetPrechargeTime===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTInitialise'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSetPrechargeTime'''
 |-
-| colspan="2" | Initialise the UART module ready for communications&nbsp;
+| colspan="2" | Specifies the precharge time for the ADC input readings in microseconds. The longer the time the more immune to noise the reading will be.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
+| width="90%" | ChargeTime
 |-
-| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
+| colspan="2" | Default 10&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 466: / Line 449: @@
-===UARTCheckRX===
+===ADCSetReferenceVoltage===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTCheckRX'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSetReferenceVoltage'''
 |-
-| colspan="2" | Check to see if the UART module has received any data&nbsp;
+| colspan="2" | Specified the reference setting for ADC reads.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
+| width="90%" | RefType
 |-
-| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
+| colspan="2" | 0=AREF, 1=VCC, 3=Internal 1.1V&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===RegisterWrite===
+===I2CInitialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RegisterWrite'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CInitialise'''
 |-
-| colspan="2" | Writes to one of the registers on-board the device&nbsp;
+| colspan="2" | Initialsie the I2C module ready for communications&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | RegisterAddress
+| width="90%" | Channel
 |-
-| colspan="2" | The address of the register&nbsp;
+| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Data
+| width="90%" | Baud
 |-
-| colspan="2" | The data value to assign to the register&nbsp;
+| colspan="2" | 0=100KHz, 1=400KHz, 2=1MHz&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 509: / Line 492: @@
-===ADCSetPrechargeTime===
+===I2CReceive===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSetPrechargeTime'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CReceive'''
 |-
-| colspan="2" | Specifies the precharge time for the ADC input readings in microseconds. The longer the time the more immune to noise the reading will be.&nbsp;
+| colspan="2" | Receive a byte using the I2C bus&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | ChargeTime
+| width="90%" | Channel
+|-
+| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Last
 |-
-| colspan="2" | Default 10&nbsp;
+| colspan="2" | Last byte to receive: Range 0-1&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===RegisterRead===
+===I2CRestart===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RegisterRead'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CRestart'''
 |-
-| colspan="2" | Read one of the registers on-board the device&nbsp;
+| colspan="2" | Put the I2C Module into Restart mode&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | RegisterAddress
+| width="90%" | Channel
 |-
-| colspan="2" | The address of the register&nbsp;
+| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===I2CRestart===
+===I2CSend===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CRestart'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CSend'''
 |-
-| colspan="2" | Put the I2C Module into Restart mode&nbsp;
+| colspan="2" | Transmit a byte using the I2C bus&nbsp;
 |-
 |-
@@ Line 561: / Line 549: @@
 | colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | DataOut
+|-
+| colspan="2" | &nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===PWMDisable===
+===I2CStart===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMDisable'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CStart'''
 |-
-| colspan="2" | Disable a PWM output&nbsp;
+| colspan="2" | Put the I2C Module into Start mode&nbsp;
 |-
 |-
@@ Line 578: / Line 571: @@
 | width="90%" | Channel
 |-
-| colspan="2" | Range: 0-1&nbsp;
+| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 585: / Line 578: @@
-===I2CStart===
+===I2CStop===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CStart'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CStop'''
 |-
-| colspan="2" | Put the I2C Module into Start mode&nbsp;
+| colspan="2" | Put the I2C Module into Stop mode&nbsp;
 |-
 |-
@@ Line 597: / Line 590: @@
 | width="90%" | Channel
 |-
-| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 604: / Line 597: @@
-===SPITransfer===
+===I2CTransInit===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPITransfer'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CTransInit'''
 |-
-| colspan="2" | Transfer a byte using the SPI bus&nbsp;
+| colspan="2" | Initialises the I2C Transaction mode with the 7-bit device address&nbsp;
 |-
 |-
@@ Line 616: / Line 609: @@
 | width="90%" | Channel
 |-
-| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
+| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | DeviceAddress
+|-
+| colspan="2" | 7-bit Device Address&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | DataOut
+| width="90%" | Baud
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | 0=100KHz, 1=400KHz, 2=1MHz&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===I2CReceive===
+===I2CTransReceive===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CReceive'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CTransReceive'''
 |-
-| colspan="2" | Receive a byte using the I2C bus&nbsp;
+| colspan="2" | Receives an I2C Transaction on the selected I2C channel. Returns the number of bytes received.&nbsp;
 |-
 |-
@@ Line 642: / Line 640: @@
 | colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Last
+| width="90%" | Data
+|-
+| colspan="2" | Data variable to receive into&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Count
 |-
-| colspan="2" | Last byte to receive: Range 0-1&nbsp;
+| colspan="2" | Number of bytes to receive&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===I2CStop===
+===I2CTransSend===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CStop'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CTransSend'''
 |-
-| colspan="2" | Put the I2C Module into Stop mode&nbsp;
+| colspan="2" | Sends an I2C Transaction on the selected I2C channel. Returns the number of bytes sent.&nbsp;
 |-
 |-
@@ Line 664: / Line 667: @@
 | width="90%" | Channel
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Data
+|-
+| colspan="2" | Data to send&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Count
+|-
+| colspan="2" | Number of bytes to send out, MS bit 0x8000 signifies no Stop if set&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===ADCSetReferenceVoltage===
+===IOGetInputPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSetReferenceVoltage'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IOGetInputPin'''
 |-
-| colspan="2" | Specified the reference setting for ADC reads.&nbsp;
+| colspan="2" | Sets the selected digital pin to an input and reads the input state.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | RefType
+| width="90%" | Pin
 |-
-| colspan="2" | 0=AREF, 1=VCC, 3=Internal 1.1V&nbsp;
+| colspan="2" | Range: 0-18&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===SPIPrescaler===
+===IOSetOutputPin===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPIPrescaler'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IOSetOutputPin'''
 |-
-| colspan="2" | Modify the speed of the SPI bus&nbsp;
+| colspan="2" | Sets the selected digital pin to an output and assigns the output state.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
+| width="90%" | Pin
 |-
-| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
+| colspan="2" | Range: 0-18&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | Prescaler
+| width="90%" | State
 |-
-| colspan="2" | Range: 0-2&nbsp;
+| colspan="2" | Range: 0-1&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 714: / Line 727: @@
-===PWMSetDuty===
+===Initialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMSetDuty'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| colspan="2" | Sets the duty for the PWM output&nbsp;
+| colspan="2" | Initialise the comms to the Arduino board ready for commands to be sent.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Channel
 |-
-| colspan="2" | Range: 0-5&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Duty
-|-
-| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 738: / Line 741: @@
-===ADCSample10===
+===PWMDisable===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSample10'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMDisable'''
 |-
-| colspan="2" | Reads the voltage present on an Alanog pin as an 10-bit value range 0-1023&nbsp;
+| colspan="2" | Disable a PWM output&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | ADCChannel
+| width="90%" | Channel
 |-
-| colspan="2" | Range: 0-12&nbsp;
+| colspan="2" | Range: 0-1&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===I2CTransSend===
+===PWMEnable===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CTransSend'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMEnable'''
 |-
-| colspan="2" | Sends an I2C Transaction on the selected I2C channel. Returns the number of bytes sent.&nbsp;
+| colspan="2" | Enable a PWM output&nbsp;
 |-
 |-
@@ Line 769: / Line 772: @@
 | width="90%" | Channel
 |-
-| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
+| colspan="2" | Range: 0-1&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | Data
-|-
-| colspan="2" | Data to send&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Count
-|-
-| colspan="2" | Number of bytes to send out, MS bit 0x8000 signifies no Stop if set&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===I2CTransInit===
+===PWMSetDuty===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CTransInit'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMSetDuty'''
 |-
-| colspan="2" | Initialises the I2C Transaction mode with the 7-bit device address&nbsp;
+| colspan="2" | Sets the duty for the PWM output&nbsp;
 |-
 |-
@@ Line 798: / Line 791: @@
 | width="90%" | Channel
 |-
-| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
+| colspan="2" | Range: 0-5&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | DeviceAddress
+| width="90%" | Duty
 |-
-| colspan="2" | 7-bit Device Address&nbsp;
+| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Baud
-|-
-| colspan="2" | 0=100KHz, 1=400KHz, 2=1MHz&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 815: / Line 803: @@
-===IOSetOutputPin===
+===PWMSetPrescaler===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IOSetOutputPin'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMSetPrescaler'''
+|-
+| colspan="2" | Sets the prescaler for the PWM output&nbsp;
+|-
 |-
-| colspan="2" | Sets the selected digital pin to an output and assigns the output state.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Channel
 |-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Pin
+| width="90%" | Prescaler
 |-
-| colspan="2" | Range: 0-18&nbsp;
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | State
+| width="90%" | Period
 |-
-| colspan="2" | Range: 0-1&nbsp;
+| colspan="2" | Default 255&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 839: / Line 832: @@
-===UARTReceive===
+===RegisterRead===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTReceive'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RegisterRead'''
 |-
-| colspan="2" | Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.&nbsp;
+| colspan="2" | Read one of the registers on-board the device&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Channel
+| width="90%" | RegisterAddress
 |-
-| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
+| colspan="2" | The address of the register&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 858: / Line 851: @@
-===ADCSampleAverage10===
+===RegisterWrite===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSampleAverage10'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RegisterWrite'''
 |-
-| colspan="2" | Reads the voltage present on an Analog pin as an 10-bit value range 0-1023. Performs the selected number of samples with the selected time in microseconds in between samples&nbsp;
+| colspan="2" | Writes to one of the registers on-board the device&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | ADCChannel
+| width="90%" | RegisterAddress
 |-
-| colspan="2" | Range: 0-5&nbsp;
+| colspan="2" | The address of the register&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | SampleCount
+| width="90%" | Data
 |-
-| colspan="2" | Range: 1- 100&nbsp;
+| colspan="2" | The data value to assign to the register&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" | SampleDelay
-|-
-| colspan="2" | Delay in us between each sample&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 906: / Line 894: @@
-===I2CSend===
+===SPIPrescaler===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''I2CSend'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPIPrescaler'''
 |-
-| colspan="2" | Transmit a byte using the I2C bus&nbsp;
+| colspan="2" | Modify the speed of the SPI bus&nbsp;
 |-
 |-
@@ Line 918: / Line 906: @@
 | width="90%" | Channel
 |-
-| colspan="2" | Channel Index: Range 0 - I2C Bus Count - 1&nbsp;
+| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | DataOut
+| width="90%" | Prescaler
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Range: 0-2&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===UARTSend===
+===SPITransfer===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTSend'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPITransfer'''
 |-
-| colspan="2" | Send a byte via the UART module&nbsp;
+| colspan="2" | Transfer a byte using the SPI bus&nbsp;
 |-
 |-
@@ Line 942: / Line 930: @@
 | width="90%" | Channel
 |-
-| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
+| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Data
+| width="90%" | DataOut
 |-
-| colspan="2" | Data Byte to send. Range: 0-255&nbsp;
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
-===PWMSetPrescaler===
+===SPITransferTrans===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMSetPrescaler'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SPITransferTrans'''
 |-
-| colspan="2" | Sets the prescaler for the PWM output&nbsp;
+| colspan="2" | Transfer an array of bytes using the SPI bus&nbsp;
 |-
 |-
@@ Line 966: / Line 954: @@
 | width="90%" | Channel
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Channel Index: Range 0 - SPI Bus Count - 1&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Count
+|-
+| colspan="2" | Number of bytes to send and receive&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Prescaler
+| width="90%" | DataOut
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Outgoing data&nbsp;
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Period
+| width="90%" | DataIn
 |-
-| colspan="2" | Default 255&nbsp;
+| colspan="2" | Incoming data&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 983: / Line 976: @@
-===PWMEnable===
+===UARTBaud===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PWMEnable'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTBaud'''
 |-
-| colspan="2" | Enable a PWM output&nbsp;
+| colspan="2" | Control the communications rate of the UART module&nbsp;
 |-
 |-
@@ Line 995: / Line 988: @@
 | width="90%" | Channel
 |-
-| colspan="2" | Range: 0-1&nbsp;
+| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Rate
+|-
+| colspan="2" | 0=1200, 1=2400, 2=4800, 3=9600, 4=19200, 5=38400, 6=57600, 7=115200&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 1,002: / Line 1,000: @@
-===ADCSampleArray10===
+===UARTCheckRX===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSampleArray10'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTCheckRX'''
 |-
-| colspan="2" | Reads the voltage present on an Analog pin as an 10-bit value range 0-1023 Performs the selected number of samples with the selected time in microseconds in between samples and returns each sample in a single packet&nbsp;
+| colspan="2" | Check to see if the UART module has received any data&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | ADCChannel
+| width="90%" | Channel
 |-
-| colspan="2" | Range: 0-5&nbsp;
+| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | SampleCount
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
+===UARTInitialise===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| colspan="2" | Range: 1- 32&nbsp;
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTInitialise'''
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| colspan="2" | Initialise the UART module ready for communications&nbsp;
-| width="90%" | SampleDelay
 |-
-| colspan="2" | Delay in us between each sample&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Samples
+| width="90%" | Channel
 |-
-| colspan="2" | 10-bit samples returned from the function&nbsp;
+| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 1,036: / Line 1,038: @@
-===ADCSampleAverage8===
+===UARTReceive===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ADCSampleAverage8'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTReceive'''
 |-
-| colspan="2" | Reads the voltage present on an Analog pin as an 8-bit value range 0-255 Performs the selected number of samples with the selected time in microseconds in between samples&nbsp;
+| colspan="2" | Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | ADCChannel
+| width="90%" | Channel
 |-
-| colspan="2" | Range: 0-5&nbsp;
+| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | SampleCount
-|-
-| colspan="2" | Range: 1- 100&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | SampleDelay
-|-
-| colspan="2" | Delay in us between each sample&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
@@ Line 1,065: / Line 1,057: @@
-===Initialise===
+===UARTSend===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''UARTSend'''
+|-
+| colspan="2" | Send a byte via the UART module&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Channel
+|-
+| colspan="2" | Channel Index: Range 0 - UART Bus Count - 1&nbsp;
 |-
-| colspan="2" | Initialise the comms to the Arduino board ready for commands to be sent.&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Data
 |-
+| colspan="2" | Data Byte to send. Range: 0-255&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID

Difference between revisions of "Component: API (ECIO28P) (API Slave Devices)"

Revision as of 12:00, 3 February 2023

Contents

API (ECIO28P) component

Component Source Code

Detailed description

Examples

Pin Mapping

Direct Slave Access

Rapid Development - Virtualised SPI

Rapid Development - Virtualised I2C

Rapid Development - Virtualised UART

Macro reference

ADCSample10

ADCSample8

ADCSampleArray10

ADCSampleArray8

ADCSampleAverage10

ADCSampleAverage8

ADCSetPrechargeTime

ADCSetReferenceVoltage

I2CInitialise

I2CReceive

I2CRestart

I2CSend

I2CStart

I2CStop

I2CTransInit

I2CTransReceive

I2CTransSend

IOGetInputPin

IOSetOutputPin

Initialise

PWMDisable

PWMEnable

PWMSetDuty

PWMSetPrescaler

RegisterRead

RegisterWrite

SPIInitialise

SPIPrescaler

SPITransfer

SPITransferTrans

UARTBaud

UARTCheckRX

UARTInitialise

UARTReceive

UARTSend

Property reference

Navigation menu

Search