Component: MIAC Serial (MIAC: Addon Modules)
| Author | Matrix TSL |
| Version | 1.0 (Release) |
| Category | MIAC: Addon Modules |
Contents
- 1 MIAC Serial component
- 2 Examples
- 3 Downloadable macro reference
- 3.1 UART_ReceiveChar
- 3.2 FAT_OpenFile
- 3.3 PWM_Enable
- 3.4 MI2C_Send_Byte_Transaction
- 3.5 SERIAL_ReceiveChar
- 3.6 FAT_Init
- 3.7 SERIAL_SendChar
- 3.8 SPI_Uninit
- 3.9 MI2C_Stop
- 3.10 UART_SendString
- 3.11 FAT_ScanCurrentFolder
- 3.12 SPI_Init
- 3.13 FAT_AppendStringToFile
- 3.14 MI2C_Restart
- 3.15 FAT_OpenFolder
- 3.16 LED_Control
- 3.17 SPI_Get_Char
- 3.18 UART_Initialize
- 3.19 FAT_MoveToNextFileSector
- 3.20 FAT_ReadByteFromScan
- 3.21 SPI_Send_Char
- 3.22 FAT_ReadFileLength
- 3.23 MI2C_Transmit_Byte
- 3.24 FAT_CreateFile
- 3.25 MI2C_Init
- 3.26 MI2C_Receive_Byte
- 3.27 PWM_Disable
- 3.28 SERIAL_ReceiveString
- 3.29 FAT_WriteFileSector
- 3.30 SERIAL_SendString
- 3.31 MI2C_Receive_Byte_Transaction
- 3.32 DigitalOutput
- 3.33 FAT_ReadByteFromBuffer
- 3.34 FAT_ReadFileSector
- 3.35 FAT_WriteByteToBuffer
- 3.36 SERIAL_Initialize
- 3.37 FAT_DeleteFile
- 3.38 AnalogInput
- 3.39 Initialize
- 3.40 UART_ReceiveString
- 3.41 PWM_SetDuty
- 3.42 MI2C_Start
- 3.43 DigitalInput
- 3.44 UART_SendChar
- 4 Simulation macro reference
- 5 Property reference
MIAC Serial component
Serial Addon expansion module for MIAC System
Examples
No additional examples
Downloadable macro reference
UART_ReceiveChar
No additional information
Parameters
- BYTE Timeout
Return value
FAT_OpenFile
No additional information
Parameters
- <- STRING Filename
- This parameter may be returned back to the caller
Return value
PWM_Enable
Enable the PWM on Channel 1 or 2
Parameters
- BYTE Channel
- PWM Channel 1 or 2
Return value
- This call does not return a value
MI2C_Send_Byte_Transaction
No additional information
Parameters
- BYTE Device_ID
- BYTE AddrH
- BYTE AddrL
- BYTE Data
Return value
- This call does not return a value
SERIAL_ReceiveChar
No additional information
Parameters
- BYTE Timeout
Return value
FAT_Init
No additional information
Parameters
- This macro has no parameters
Return value
SERIAL_SendChar
No additional information
Parameters
- UINT Character
Return value
- This call does not return a value
SPI_Uninit
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
MI2C_Stop
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
UART_SendString
No additional information
Parameters
- <- STRING Text
- This parameter may be returned back to the caller
Return value
- This call does not return a value
FAT_ScanCurrentFolder
No additional information
Parameters
- UINT idx
- BYTE type
- Scan type
Return value
SPI_Init
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
FAT_AppendStringToFile
No additional information
Parameters
- <- STRING Text
- This parameter may be returned back to the caller
Return value
MI2C_Restart
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
FAT_OpenFolder
No additional information
Parameters
- <- STRING Folder
- This parameter may be returned back to the caller
Return value
LED_Control
Sets the indicator LED On (State=1) or Off (State=0)
Parameters
- BYTE State
Return value
- This call does not return a value
SPI_Get_Char
No additional information
Parameters
- This macro has no parameters
Return value
UART_Initialize
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
FAT_MoveToNextFileSector
No additional information
Parameters
- BYTE force
- force next sector
Return value
FAT_ReadByteFromScan
No additional information
Parameters
- UINT idx
Return value
SPI_Send_Char
No additional information
Parameters
- BYTE Char
Return value
- This call does not return a value
FAT_ReadFileLength
No additional information
Parameters
- This macro has no parameters
Return value
MI2C_Transmit_Byte
No additional information
Parameters
- BYTE Data
Return value
FAT_CreateFile
No additional information
Parameters
- <- STRING Filename
- This parameter may be returned back to the caller
Return value
MI2C_Init
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
MI2C_Receive_Byte
No additional information
Parameters
- BYTE Last
Return value
PWM_Disable
Disable the PWM on Channel 1 or 2
Parameters
- BYTE Channel
- PWM Channel 1 or 2
Return value
- This call does not return a value
SERIAL_ReceiveString
No additional information
Parameters
- BYTE Timeout
- BYTE NumBytes
Return value
FAT_WriteFileSector
No additional information
Parameters
- This macro has no parameters
Return value
SERIAL_SendString
No additional information
Parameters
- <- STRING Text
- This parameter may be returned back to the caller
Return value
- This call does not return a value
MI2C_Receive_Byte_Transaction
No additional information
Parameters
- BYTE Device_ID
- BYTE AddrH
- BYTE AddrL
Return value
DigitalOutput
Set a Terminal Output to High (Value=1) or Low (Value=0)
Parameters
- BYTE Terminal
- BYTE Value
Return value
FAT_ReadByteFromBuffer
No additional information
Parameters
- UINT address
Return value
FAT_ReadFileSector
No additional information
Parameters
- This macro has no parameters
Return value
FAT_WriteByteToBuffer
No additional information
Parameters
- UINT address
- BYTE data
Return value
- This call does not return a value
SERIAL_Initialize
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
FAT_DeleteFile
No additional information
Parameters
- <- STRING Filename
- This parameter may be returned back to the caller
Return value
AnalogInput
Read the ADC value of a Terminal
Returns 12 bit ADC reading
Parameters
- BYTE Terminal
- Terminal number to be read
Return value
Initialize
Forces a software reset on the module
Parameters
- This macro has no parameters
Return value
- This call does not return a value
UART_ReceiveString
No additional information
Parameters
- BYTE Timeout
- BYTE NumBytes
Return value
PWM_SetDuty
Sets the PWM Duty cycle on Channel 1 or 2
Parameters
- BYTE Channel
- PWM Channel 1 or 2
- BYTE Duty
- Duty cycle (8 bit value)
Return value
- This call does not return a value
MI2C_Start
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
DigitalInput
Read the value of a terminal
Parameters
- BYTE Terminal
Return value
UART_SendChar
No additional information
Parameters
- UINT Character
Return value
- This call does not return a value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Module Type
This property is of type Fixed list of ints and can be referenced with the variable name MODULE_TYPE.
No additional information
Module Address
This property is of type Fixed list of ints and can be referenced with the variable name ORDINAL.
No additional information
Period Overflow
This property is of type Unsigned integer and can be referenced with the variable name PERIOD.
No additional information
Prescaler
This property is of type Fixed list of ints and can be referenced with the variable name PRESCALER.
No additional information
Frequency (KHz)
This property is of type Floating point and can be referenced with the variable name PWM_FREQ.
No additional information
Period (uS)
This property is of type Floating point and can be referenced with the variable name PWM_PERIOD.
No additional information
Baud Rate
This property is of type Unsigned integer and can be referenced with the variable name BAUD1.
No additional information
Data Bits
This property is of type Fixed list of ints and can be referenced with the variable name BITS1.
No additional information
Return Type
This property is of type Fixed list of ints and can be referenced with the variable name RET1.
No additional information
Echo
This property is of type Fixed list of ints and can be referenced with the variable name ECHO1.
No additional information
Flow Control
This property is of type Fixed list of ints and can be referenced with the variable name FLOW1.
No additional information
Rate
This property is of type Fixed list of ints and can be referenced with the variable name SPI_RATE.
Prescale option selector
Clock Polarity
This property is of type Fixed list of ints and can be referenced with the variable name CKP.
Clock Polarity setting, inactive (idle) state
Clock Phase
This property is of type Fixed list of ints and can be referenced with the variable name CKE.
Clock Phase (data change edge) selection
Sample Point
This property is of type Fixed list of ints and can be referenced with the variable name SMP.
Data bit read sample point
Baud Select
This property is of type Fixed list of ints and can be referenced with the variable name I2C_BAUD.
Baud rate option selector
Slew Rate Control
This property is of type Fixed list of ints and can be referenced with the variable name I2C_SRC.
Slew Rate Control Enabled or Disabled
SMBus Inputs
This property is of type Fixed list of ints and can be referenced with the variable name I2C_SMB.
When Enabled input logic thresholds are compliant with SMBus specification
Baud Rate
This property is of type Unsigned integer and can be referenced with the variable name BAUD2.
No additional information
Data Bits
This property is of type Fixed list of ints and can be referenced with the variable name BITS2.
No additional information
Return Type
This property is of type Fixed list of ints and can be referenced with the variable name RET2.
No additional information
Echo
This property is of type Fixed list of ints and can be referenced with the variable name ECHO2.
No additional information
Flow Control
This property is of type Fixed list of ints and can be referenced with the variable name FLOW2.
No additional information
