Jump to content

Component: MIAC Basic (MIAC: Addon Modules): Difference between revisions

From Flowcode Help
← Older editNewer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
No edit summary
No edit summary
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_ma_basic.fcfx FC_Comp_Source_ma_basic.fcfx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ma_basic.fcfx FC_Comp_Source_ma_basic.fcfx]


Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ma_basic.fcfx FC_Comp_Source_ma_basic.fcfx]
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ma_basic.fcfx FC_Comp_Source_ma_basic.fcfx]


==Detailed description==
==Detailed description==




Line 36: Line 38:


==Examples==
==Examples==




Line 52: Line 56:


==Macro reference==
==Macro reference==
{| 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;" | '''PWM_Enable'''
|-
| colspan="2" | Enable the PWM on Channel 1 or 2 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | PWM Channel 1 or 2 
|-
| 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''
|}
{| 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;" | '''MIAC_Module_SetData'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Count
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D0
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D1
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D2
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D3
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D4
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D5
|-
| colspan="2" |  
|-
| 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''
|}
{| 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;" | '''MIAC_Module_Init'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CAN_ID
|-
| colspan="2" |  
|-
| 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''
|}
{| 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;" | '''MIAC_Module_GetData'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Index
|-
| colspan="2" |  
|-
| 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''
|}
{| 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;" | '''MIAC_Module_Message'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CAN_ID
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CMD_ID
|-
| colspan="2" |  
|-
| 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''
|}
{| 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;" | '''LED_Control'''
|-
| colspan="2" | Sets the indicator LED On (State=1) or Off (State=0) 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | State
|-
| colspan="2" |  
|-
| 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''
|}
{| 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;" | '''MIAC_Module_PushData'''
|-
| colspan="2" |  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| colspan="2" |  
|-
| 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''
|}
{| 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;" | '''PWM_Disable'''
|-
| colspan="2" | Disable the PWM on Channel 1 or 2 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | PWM Channel 1 or 2 
|-
| 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''
|}
{| 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;" | '''DigitalOutput'''
|-
| colspan="2" | Set a Terminal Output to High (Value=1) or Low (Value=0) 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Terminal
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value
|-
| colspan="2" |  
|-
| 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''
|}
{| 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;" | '''AnalogInput'''
|-
| colspan="2" | Read the ADC value of a Terminal Returns 12 bit ADC reading 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Terminal
|-
| colspan="2" | Terminal number to be read 
|-
| 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''
|}
{| 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;" | '''Initialize'''
|-
| colspan="2" | Forces a software reset on the module 
|-
|-
| 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''
|}
{| 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;" | '''PWM_SetDuty'''
|-
| colspan="2" | Sets the PWM Duty cycle on Channel 1 or 2 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | PWM Channel 1 or 2 
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Duty
|-
| colspan="2" | Duty cycle (8 bit value) 
|-
| 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''
|}
{| 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;" | '''DigitalInput'''
|-
| colspan="2" | Read the value of a terminal  
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Terminal
|-
| colspan="2" |  
|-
| 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''
|}
==Property reference==
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Module Type
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Module Address
|-
| colspan="2" |  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | PWM
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Period Overflow
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Prescaler
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Frequency (KHz)
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
| width="90%" | Period (uS)
|-
| colspan="2" |  
|}==Macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 10:01, 27 January 2023

Author
Version 1.0
Category MIAC: Addon Modules


MIAC Basic component

Basic Addon expansion module for MIAC System

Component Source Code

Please click here to download the component source project: FC_Comp_Source_ma_basic.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_ma_basic.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Macro reference

PWM_Enable
Enable the PWM on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- VOID Return


MIAC_Module_SetData
 
- BYTE Count
 
- BYTE D0
 
- BYTE D1
 
- BYTE D2
 
- BYTE D3
 
- BYTE D4
 
- BYTE D5
 
- VOID Return


MIAC_Module_Init
 
- UINT CAN_ID
 
- VOID Return


MIAC_Module_GetData
 
- BYTE Index
 
- BYTE Return


MIAC_Module_Message
 
- UINT CAN_ID
 
- UINT CMD_ID
 
- BYTE Return


LED_Control
Sets the indicator LED On (State=1) or Off (State=0) 
- BYTE State
 
- VOID Return


MIAC_Module_PushData
 
- BYTE Data
 
- VOID Return


PWM_Disable
Disable the PWM on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- VOID Return


DigitalOutput
Set a Terminal Output to High (Value=1) or Low (Value=0) 
- BYTE Terminal
 
- BYTE Value
 
- BYTE Return


AnalogInput
Read the ADC value of a Terminal Returns 12 bit ADC reading 
- BYTE Terminal
Terminal number to be read 
- UINT Return


Initialize
Forces a software reset on the module 
- VOID Return


PWM_SetDuty
Sets the PWM Duty cycle on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- BYTE Duty
Duty cycle (8 bit value) 
- VOID Return


DigitalInput
Read the value of a terminal  
- BYTE Terminal
 
- BYTE Return



Property reference

Properties
Module Type
 
Module Address
 
PWM
Period Overflow
 
Prescaler
 
Frequency (KHz)
 
Period (uS)
 

==Macro reference==

PWM_Enable
Enable the PWM on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- VOID Return


MIAC_Module_SetData
 
- BYTE Count
 
- BYTE D0
 
- BYTE D1
 
- BYTE D2
 
- BYTE D3
 
- BYTE D4
 
- BYTE D5
 
- VOID Return


MIAC_Module_Init
 
- UINT CAN_ID
 
- VOID Return


MIAC_Module_GetData
 
- BYTE Index
 
- BYTE Return


MIAC_Module_Message
 
- UINT CAN_ID
 
- UINT CMD_ID
 
- BYTE Return


LED_Control
Sets the indicator LED On (State=1) or Off (State=0) 
- BYTE State
 
- VOID Return


MIAC_Module_PushData
 
- BYTE Data
 
- VOID Return


PWM_Disable
Disable the PWM on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- VOID Return


DigitalOutput
Set a Terminal Output to High (Value=1) or Low (Value=0) 
- BYTE Terminal
 
- BYTE Value
 
- BYTE Return


AnalogInput
Read the ADC value of a Terminal Returns 12 bit ADC reading 
- BYTE Terminal
Terminal number to be read 
- UINT Return


Initialize
Forces a software reset on the module 
- VOID Return


PWM_SetDuty
Sets the PWM Duty cycle on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- BYTE Duty
Duty cycle (8 bit value) 
- VOID Return


DigitalInput
Read the value of a terminal  
- BYTE Terminal
 
- BYTE Return



Property reference

Properties
Module Type
 
Module Address
 
PWM
Period Overflow
 
Prescaler
 
Frequency (KHz)
 
Period (uS)
 

==Macro reference==

PWM_Enable
Enable the PWM on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- VOID Return


MIAC_Module_SetData
 
- BYTE Count
 
- BYTE D0
 
- BYTE D1
 
- BYTE D2
 
- BYTE D3
 
- BYTE D4
 
- BYTE D5
 
- VOID Return


MIAC_Module_Init
 
- UINT CAN_ID
 
- VOID Return


MIAC_Module_GetData
 
- BYTE Index
 
- BYTE Return


MIAC_Module_Message
 
- UINT CAN_ID
 
- UINT CMD_ID
 
- BYTE Return


LED_Control
Sets the indicator LED On (State=1) or Off (State=0) 
- BYTE State
 
- VOID Return


MIAC_Module_PushData
 
- BYTE Data
 
- VOID Return


PWM_Disable
Disable the PWM on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- VOID Return


DigitalOutput
Set a Terminal Output to High (Value=1) or Low (Value=0) 
- BYTE Terminal
 
- BYTE Value
 
- BYTE Return


AnalogInput
Read the ADC value of a Terminal Returns 12 bit ADC reading 
- BYTE Terminal
Terminal number to be read 
- UINT Return


Initialize
Forces a software reset on the module 
- VOID Return


PWM_SetDuty
Sets the PWM Duty cycle on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- BYTE Duty
Duty cycle (8 bit value) 
- VOID Return


DigitalInput
Read the value of a terminal  
- BYTE Terminal
 
- BYTE Return



Property reference

Properties
Module Type
 
Module Address
 
PWM
Period Overflow
 
Prescaler
 
Frequency (KHz)
 
Period (uS)
 

==Macro reference==

PWM_Enable
Enable the PWM on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- VOID Return


MIAC_Module_SetData
 
- BYTE Count
 
- BYTE D0
 
- BYTE D1
 
- BYTE D2
 
- BYTE D3
 
- BYTE D4
 
- BYTE D5
 
- VOID Return


MIAC_Module_Init
 
- UINT CAN_ID
 
- VOID Return


MIAC_Module_GetData
 
- BYTE Index
 
- BYTE Return


MIAC_Module_Message
 
- UINT CAN_ID
 
- UINT CMD_ID
 
- BYTE Return


LED_Control
Sets the indicator LED On (State=1) or Off (State=0) 
- BYTE State
 
- VOID Return


MIAC_Module_PushData
 
- BYTE Data
 
- VOID Return


PWM_Disable
Disable the PWM on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- VOID Return


DigitalOutput
Set a Terminal Output to High (Value=1) or Low (Value=0) 
- BYTE Terminal
 
- BYTE Value
 
- BYTE Return


AnalogInput
Read the ADC value of a Terminal Returns 12 bit ADC reading 
- BYTE Terminal
Terminal number to be read 
- UINT Return


Initialize
Forces a software reset on the module 
- VOID Return


PWM_SetDuty
Sets the PWM Duty cycle on Channel 1 or 2 
- BYTE Channel
PWM Channel 1 or 2 
- BYTE Duty
Duty cycle (8 bit value) 
- VOID Return


DigitalInput
Read the value of a terminal  
- BYTE Terminal
 
- BYTE Return



Property reference

Properties
Module Type
 
Module Address
 
PWM
Period Overflow
 
Prescaler
 
Frequency (KHz)
 
Period (uS)
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_MIAC_Basic_(MIAC:_Addon_Modules)&oldid=34657"