Difference between revisions of "Component: MIAC Zigbee Coordinator (MIAC: Addon Modules)"
From Flowcode Help
Jump to navigationJump to searchLine 16: | Line 16: | ||
==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_zigbee_c.fcfx FC_Comp_Source_ma_zigbee_c.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ma_zigbee_c.fcfx FC_Comp_Source_ma_zigbee_c.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ma_zigbee_c.fcfx FC_Comp_Source_ma_zigbee_c.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
+ | |||
+ | |||
Line 32: | Line 36: | ||
==Examples== | ==Examples== | ||
+ | |||
+ | |||
Line 46: | Line 52: | ||
==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;" | '''MIAC_Module_RD''' | ||
+ | |- | ||
+ | | 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:]] - | ||
+ | | 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;" | '''MIAC_Module_WR''' | ||
+ | |- | ||
+ | | 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" | [[File:]] - | ||
+ | | width="90%" | Count | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:]] - | ||
+ | | width="90%" | Start | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:]] - | ||
+ | | width="90%" | More | ||
+ | |- | ||
+ | | 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;" | '''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;" | '''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;" | '''MIAC_Module_GetAck''' | ||
+ | |- | ||
+ | | 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" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" | TimeOut | ||
+ | |- | ||
+ | | 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;" | '''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" | | ||
+ | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |
Revision as of 15:25, 20 January 2023
Author | |
Version | 1.0 |
Category | MIAC: Addon Modules |
Contents
MIAC Zigbee Coordinator component
MIAC Zigbee Coordinator Addon component for MIAC System. Add the Zigbee component to the panel to add functionality.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_ma_zigbee_c.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_ma_zigbee_c.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
![]() |
MIAC_Module_RD |
![]() |
CAN_ID |
![]() |
CMD_ID |
[[File:]] - | Return |
![]() |
MIAC_Module_SetData |
![]() |
Count |
![]() |
D0 |
![]() |
D1 |
![]() |
D2 |
![]() |
D3 |
![]() |
D4 |
![]() |
D5 |
![]() |
Return |
![]() |
MIAC_Module_Init |
![]() |
CAN_ID |
![]() |
Return |
![]() |
MIAC_Module_GetData |
![]() |
Index |
![]() |
Return |
![]() |
MIAC_Module_Message |
![]() |
CAN_ID |
![]() |
CMD_ID |
![]() |
Return |
![]() |
MIAC_Module_WR |
![]() |
CAN_ID |
![]() |
CMD_ID |
[[File:]] - | Count |
[[File:]] - | Start |
[[File:]] - | More |
![]() |
Return |
![]() |
LED_Control |
Sets the indicator LED On (State=1) or Off (State=0) | |
![]() |
State |
![]() |
Return |
![]() |
MIAC_Module_PushData |
![]() |
Data |
![]() |
Return |
![]() |
DigitalOutput |
Set a Terminal Output to High (Value=1) or Low (Value=0) | |
![]() |
Terminal |
![]() |
Value |
![]() |
Return |
![]() |
MIAC_Module_GetAck |
![]() |
CAN_ID |
![]() |
CMD_ID |
![]() |
TimeOut |
![]() |
Return |
![]() |
AnalogInput |
Read the ADC value of a Terminal Returns 12 bit ADC reading | |
![]() |
Terminal |
Terminal number to be read | |
![]() |
Return |
![]() |
Initialize |
Forces a software reset on the module | |
![]() |
Return |
![]() |
DigitalInput |
Read the value of a terminal | |
![]() |
Terminal |
![]() |
Return |
Property reference
![]() |
Properties |
![]() |
Module Type |
![]() |
Module Address |
==Macro reference==
![]() |
MIAC_Module_RD |
![]() |
CAN_ID |
![]() |
CMD_ID |
[[File:]] - | Return |
![]() |
MIAC_Module_SetData |
![]() |
Count |
![]() |
D0 |
![]() |
D1 |
![]() |
D2 |
![]() |
D3 |
![]() |
D4 |
![]() |
D5 |
![]() |
Return |
![]() |
MIAC_Module_Init |
![]() |
CAN_ID |
![]() |
Return |
![]() |
MIAC_Module_GetData |
![]() |
Index |
![]() |
Return |
![]() |
MIAC_Module_Message |
![]() |
CAN_ID |
![]() |
CMD_ID |
![]() |
Return |
![]() |
MIAC_Module_WR |
![]() |
CAN_ID |
![]() |
CMD_ID |
[[File:]] - | Count |
[[File:]] - | Start |
[[File:]] - | More |
![]() |
Return |
![]() |
LED_Control |
Sets the indicator LED On (State=1) or Off (State=0) | |
![]() |
State |
![]() |
Return |
![]() |
MIAC_Module_PushData |
![]() |
Data |
![]() |
Return |
![]() |
DigitalOutput |
Set a Terminal Output to High (Value=1) or Low (Value=0) | |
![]() |
Terminal |
![]() |
Value |
![]() |
Return |
![]() |
MIAC_Module_GetAck |
![]() |
CAN_ID |
![]() |
CMD_ID |
![]() |
TimeOut |
![]() |
Return |
![]() |
AnalogInput |
Read the ADC value of a Terminal Returns 12 bit ADC reading | |
![]() |
Terminal |
Terminal number to be read | |
![]() |
Return |
![]() |
Initialize |
Forces a software reset on the module | |
![]() |
Return |
![]() |
DigitalInput |
Read the value of a terminal | |
![]() |
Terminal |
![]() |
Return |
Property reference
![]() |
Properties |
![]() |
Module Type |
![]() |
Module Address |
==Macro reference==
![]() |
MIAC_Module_RD |
![]() |
CAN_ID |
![]() |
CMD_ID |
[[File:]] - | Return |
![]() |
MIAC_Module_SetData |
![]() |
Count |
![]() |
D0 |
![]() |
D1 |
![]() |
D2 |
![]() |
D3 |
![]() |
D4 |
![]() |
D5 |
![]() |
Return |
![]() |
MIAC_Module_Init |
![]() |
CAN_ID |
![]() |
Return |
![]() |
MIAC_Module_GetData |
![]() |
Index |
![]() |
Return |
![]() |
MIAC_Module_Message |
![]() |
CAN_ID |
![]() |
CMD_ID |
![]() |
Return |
![]() |
MIAC_Module_WR |
![]() |
CAN_ID |
![]() |
CMD_ID |
[[File:]] - | Count |
[[File:]] - | Start |
[[File:]] - | More |
![]() |
Return |
![]() |
LED_Control |
Sets the indicator LED On (State=1) or Off (State=0) | |
![]() |
State |
![]() |
Return |
![]() |
MIAC_Module_PushData |
![]() |
Data |
![]() |
Return |
![]() |
DigitalOutput |
Set a Terminal Output to High (Value=1) or Low (Value=0) | |
![]() |
Terminal |
![]() |
Value |
![]() |
Return |
![]() |
MIAC_Module_GetAck |
![]() |
CAN_ID |
![]() |
CMD_ID |
![]() |
TimeOut |
![]() |
Return |
![]() |
AnalogInput |
Read the ADC value of a Terminal Returns 12 bit ADC reading | |
![]() |
Terminal |
Terminal number to be read | |
![]() |
Return |
![]() |
Initialize |
Forces a software reset on the module | |
![]() |
Return |
![]() |
DigitalInput |
Read the value of a terminal | |
![]() |
Terminal |
![]() |
Return |
Property reference
![]() |
Properties |
![]() |
Module Type |
![]() |
Module Address |