Wiki bot at 16:21, 7 January 2022

2022-01-07T16:21:02Z

BenR: XML import

2016-07-20T15:47:41Z

XML import

New page

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| [http://www.matrixtsl.com Matrix TSL]
|-
| width="20%" style="color: gray;" | Version
| 1.0 (Release)
|-
| width="20%" style="color: gray;" | Category
| MIAC: Addon Modules
|}

==[[File:Component Icon 126523d0_e391_4ccb_86c0_0e9d1b33d5f0.png|Image]] MIAC Serial component==
Serial Addon expansion module for MIAC System

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>UART_ReceiveChar</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Timeout''

'''Return value'''

:[[Variable Types|UINT]]

===<tt>FAT_OpenFile</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>PWM_Enable</tt>===
Enable the PWM on Channel 1 or 2

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::PWM Channel 1 or 2

'''Return value'''

:''This call does not return a value''

===<tt>MI2C_Send_Byte_Transaction</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Device_ID''

:[[Variable Types|BYTE]] ''AddrH''

:[[Variable Types|BYTE]] ''AddrL''

:[[Variable Types|BYTE]] ''Data''

'''Return value'''

:''This call does not return a value''

===<tt>SERIAL_ReceiveChar</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Timeout''

'''Return value'''

:[[Variable Types|UINT]]

===<tt>FAT_Init</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SERIAL_SendChar</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|UINT]] ''Character''

'''Return value'''

:''This call does not return a value''

===<tt>SPI_Uninit</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>MI2C_Stop</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>UART_SendString</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|<- STRING]] ''Text''
::''This parameter may be returned back to the caller''

'''Return value'''

:''This call does not return a value''

===<tt>FAT_ScanCurrentFolder</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|UINT]] ''idx''

:[[Variable Types|BYTE]] ''type''
::Scan type

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SPI_Init</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>FAT_AppendStringToFile</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|<- STRING]] ''Text''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>MI2C_Restart</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>FAT_OpenFolder</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|<- STRING]] ''Folder''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>LED_Control</tt>===
Sets the indicator LED On (State=1) or Off (State=0)

'''Parameters'''

:[[Variable Types|BYTE]] ''State''

'''Return value'''

:''This call does not return a value''

===<tt>SPI_Get_Char</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>UART_Initialize</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>FAT_MoveToNextFileSector</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''force''
::force next sector

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>FAT_ReadByteFromScan</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|UINT]] ''idx''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SPI_Send_Char</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Char''

'''Return value'''

:''This call does not return a value''

===<tt>FAT_ReadFileLength</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|UINT]]

===<tt>MI2C_Transmit_Byte</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Data''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>FAT_CreateFile</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>MI2C_Init</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>MI2C_Receive_Byte</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Last''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>PWM_Disable</tt>===
Disable the PWM on Channel 1 or 2

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::PWM Channel 1 or 2

'''Return value'''

:''This call does not return a value''

===<tt>SERIAL_ReceiveString</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Timeout''

:[[Variable Types|BYTE]] ''NumBytes''

'''Return value'''

:[[Variable Types|STRING]]

===<tt>FAT_WriteFileSector</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>SERIAL_SendString</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|<- STRING]] ''Text''
::''This parameter may be returned back to the caller''

'''Return value'''

:''This call does not return a value''

===<tt>MI2C_Receive_Byte_Transaction</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Device_ID''

:[[Variable Types|BYTE]] ''AddrH''

:[[Variable Types|BYTE]] ''AddrL''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>DigitalOutput</tt>===
Set a Terminal Output to High (Value=1) or Low (Value=0)

'''Parameters'''

:[[Variable Types|BYTE]] ''Terminal''

:[[Variable Types|BYTE]] ''Value''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>FAT_ReadByteFromBuffer</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|UINT]] ''address''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>FAT_ReadFileSector</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>FAT_WriteByteToBuffer</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|UINT]] ''address''

:[[Variable Types|BYTE]] ''data''

'''Return value'''

:''This call does not return a value''

===<tt>SERIAL_Initialize</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>FAT_DeleteFile</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|<- STRING]] ''Filename''
::''This parameter may be returned back to the caller''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>AnalogInput</tt>===
Read the ADC value of a Terminal

Returns 12 bit ADC reading

'''Parameters'''

:[[Variable Types|BYTE]] ''Terminal''
::Terminal number to be read

'''Return value'''

:[[Variable Types|UINT]]

===<tt>Initialize</tt>===
Forces a software reset on the module

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>UART_ReceiveString</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Timeout''

:[[Variable Types|BYTE]] ''NumBytes''

'''Return value'''

:[[Variable Types|STRING]]

===<tt>PWM_SetDuty</tt>===
Sets the PWM Duty cycle on Channel 1 or 2

'''Parameters'''

:[[Variable Types|BYTE]] ''Channel''
::PWM Channel 1 or 2

:[[Variable Types|BYTE]] ''Duty''
::Duty cycle (8 bit value)

'''Return value'''

:''This call does not return a value''

===<tt>MI2C_Start</tt>===
''No additional information''

'''Parameters'''

:''This macro has no parameters''

'''Return value'''

:''This call does not return a value''

===<tt>DigitalInput</tt>===
Read the value of a terminal

'''Parameters'''

:[[Variable Types|BYTE]] ''Terminal''

'''Return value'''

:[[Variable Types|BYTE]]

===<tt>UART_SendChar</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|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''

Component: MIAC Serial (MIAC: Addon Modules) - Revision history

Wiki bot at 16:21, 7 January 2022

BenR: XML import