Difference between revisions of "Component: MIAC Zigbee Coordinator (MIAC: Addon Modules)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
−
| [http://www.matrixtsl.com Matrix TSL]
+
|  
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| MIAC: Addon Modules
 
| MIAC: Addon Modules
 
|}
 
|}
 +
 +
 +
==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: [https://www.flowcode.co.uk/wiki/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==
 +
 +
 +
 +
 +
 +
 +
 +
  
  
  
−
==[[File:Component Icon b5e4faac_ed09_4e4c_a644_09e1e151a405.png|Image]] MIAC Zigbee Coordinator component==
+
 
−
MIAC Zigbee Coordinator Addon component for MIAC System.
+
 
−
Add the Zigbee component to the panel to add functionality.
+
 
 +
 
 +
''No detailed description exists yet for this component''
  
 
==Examples==
 
==Examples==
−
''<span style="color:red;">No additional examples</span>''
 
  
  
−
==Downloadable macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>LED_Control</tt></u></span>===
 
−
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''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>DigitalOutput</tt></u></span>===
 
−
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]]
+
''<span style="color:red;">No additional examples</span>''
  
  
−
===<span style="font-weight: normal;"><u><tt>AnalogInput</tt></u></span>===
 
−
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]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Initialize</tt></u></span>===
 
−
Forces a software reset on the module
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
+
==Macro reference==
  
 +
===AnalogInput===
 +
{| 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&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Terminal
 +
|-
 +
| colspan="2" | Terminal number to be read&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''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
===DigitalInput===
 +
{| 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 &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Terminal
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>DigitalInput</tt></u></span>===
+
===DigitalOutput===
−
Read the value of a terminal
+
{| 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)&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Terminal
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Value
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Terminal''
+
===Initialize===
 +
{| 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&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
  
−
'''Return value'''
+
===LED_Control===
 +
{| 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)&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | State
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
:[[Variable Types|BYTE]]
 
  
 +
===MIAC_Module_GetAck===
 +
{| 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" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CAN_ID
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CMD_ID
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | TimeOut
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
  
−
==Simulation macro reference==
+
===MIAC_Module_GetData===
 +
{| 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" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
−
''This component does not contain any simulation macros''
 
  
 +
===MIAC_Module_Init===
 +
{| 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" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CAN_ID
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Module Type</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''MODULE_TYPE''.
+
===MIAC_Module_Message===
 +
{| 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" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CAN_ID
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CMD_ID
 +
|-
 +
| colspan="2" | &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''
 +
|}
  
−
''<span style="color:red;">No additional information</span>''
 
  
 +
===MIAC_Module_PushData===
 +
{| 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" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
  
−
<span style="font-weight: normal;"><u>Module Address</u></span>
+
===MIAC_Module_RD===
 +
{| 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" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CAN_ID
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CMD_ID
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] -
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''ORDINAL''.
 
  
−
''<span style="color:red;">No additional information</span>''
+
===MIAC_Module_SetData===
 +
{| 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" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Count
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D0
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D2
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D3
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D4
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | D5
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
 +
 
 +
 
 +
===MIAC_Module_WR===
 +
{| 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" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CAN_ID
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CMD_ID
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Count
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Start
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | More
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
 +
 
 +
 
 +
==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" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Module Address
 +
|-
 +
| colspan="2" | &nbsp;
 +
|}

Latest revision as of 13:13, 7 February 2023

Author
Version 1.0
Category MIAC: Addon Modules


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

AnalogInput

Fc9-comp-macro.png AnalogInput
Read the ADC value of a Terminal Returns 12 bit ADC reading 
Fc9-u8-icon.png - BYTE Terminal
Terminal number to be read 
Fc9-u16-icon.png - UINT Return


DigitalInput

Fc9-comp-macro.png DigitalInput
Read the value of a terminal  
Fc9-u8-icon.png - BYTE Terminal
 
Fc9-u8-icon.png - BYTE Return


DigitalOutput

Fc9-comp-macro.png DigitalOutput
Set a Terminal Output to High (Value=1) or Low (Value=0) 
Fc9-u8-icon.png - BYTE Terminal
 
Fc9-u8-icon.png - BYTE Value
 
Fc9-u8-icon.png - BYTE Return


Initialize

Fc9-comp-macro.png Initialize
Forces a software reset on the module 
Fc9-void-icon.png - VOID Return


LED_Control

Fc9-comp-macro.png LED_Control
Sets the indicator LED On (State=1) or Off (State=0) 
Fc9-u8-icon.png - BYTE State
 
Fc9-void-icon.png - VOID Return


MIAC_Module_GetAck

Fc9-comp-macro.png MIAC_Module_GetAck
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
Fc9-u16-icon.png - UINT TimeOut
 
Fc9-u8-icon.png - BYTE Return


MIAC_Module_GetData

Fc9-comp-macro.png MIAC_Module_GetData
 
Fc9-u8-icon.png - BYTE Index
 
Fc9-u8-icon.png - BYTE Return


MIAC_Module_Init

Fc9-comp-macro.png MIAC_Module_Init
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-void-icon.png - VOID Return


MIAC_Module_Message

Fc9-comp-macro.png MIAC_Module_Message
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
Fc9-u8-icon.png - BYTE Return


MIAC_Module_PushData

Fc9-comp-macro.png MIAC_Module_PushData
 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


MIAC_Module_RD

Fc9-comp-macro.png MIAC_Module_RD
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
[[File:]] - Return


MIAC_Module_SetData

Fc9-comp-macro.png MIAC_Module_SetData
 
Fc9-u8-icon.png - BYTE Count
 
Fc9-u8-icon.png - BYTE D0
 
Fc9-u8-icon.png - BYTE D1
 
Fc9-u8-icon.png - BYTE D2
 
Fc9-u8-icon.png - BYTE D3
 
Fc9-u8-icon.png - BYTE D4
 
Fc9-u8-icon.png - BYTE D5
 
Fc9-void-icon.png - VOID Return


MIAC_Module_WR

Fc9-comp-macro.png MIAC_Module_WR
 
Fc9-u16-icon.png - UINT CAN_ID
 
Fc9-u16-icon.png - UINT CMD_ID
 
[[File:]] - Count
 
[[File:]] - Start
 
[[File:]] - More
 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-16-icon.png Module Type
 
Fc9-type-16-icon.png Module Address
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_MIAC_Zigbee_Coordinator_(MIAC:_Addon_Modules)&oldid=38467"