Jump to content

Component: MIAC NXT AllCode API (AllCode): Difference between revisions

From Flowcode Help

SteveT (talk | contribs)

4 user groups
6,427 edits
Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix TSL |- | width="20%" style="color:gray;" | Version | 1.1 |- | width="20%" style="color:gray..."
 
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(15 intermediate revisions by 2 users not shown)
Line 17: Line 17:
==Component Source Code==
==Component Source Code==


Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_MIAC_NXT_AllCode_Component_Source.fcsx FC_Comp_Source_MIAC_NXT_AllCode_Component_Source.fcsx]
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_MIAC_NXT_AllCode_Component_Source.fcsx FC_Comp_Source_MIAC_NXT_AllCode_Component_Source.fcsx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_MIAC_NXT_AllCode_Component_Source.fcsx FC_Comp_Source_MIAC_NXT_AllCode_Component_Source.fcsx]


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


''No detailed description exists yet for this component''
''No detailed description exists yet for this component''


==Examples==
==Examples==


''<span style="color:red;">No additional examples</span>''
''<span style="color:red;">No additional examples</span>''


==Downloadable macro reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
 
 
 
 
 
 
 
 
==Macro reference==
 
===DisplayClear===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteTranPWMEnable'''
| width="90%" class="mtx-class-macrohead" | '''DisplayClear'''
|-
|-
| colspan="2" | Allows pulse width modulated transistor outputs to be switched on or off.&nbsp;
| colspan="2" | Clears the MIAC display&nbsp;
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
|-
| colspan="2" | Range: 1-4 Where 1=A / 2=B / 3=C / 4=D&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | EnableOrState
|-
| colspan="2" | PWM on Enable Pin or State Pin - 1 = Enable / 0 = State&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | OnOrOff
|-
| colspan="2" | 1 = Enabled / 0 = Disabled&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 57: Line 79:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===DisplayCursor===
{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''DisplayCursor'''
|-
| colspan="2" | Sets the cursor position for the MIAC display&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteTrans'''
|-
|-
| colspan="2" | Allows all transistor outputs to be switched on or off in a single command.&nbsp;
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | X
|-
|-
| colspan="2" | Range: 0-21&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value
| width="90%" | Y
|-
|-
| colspan="2" | Range: 0-63 or 0b000000 to 0b111111&nbsp;
| colspan="2" | Range: 0-3&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 75: Line 103:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===DisplayFloat===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayPrint'''
| width="90%" class="mtx-class-macrohead" | '''DisplayFloat'''
|-
|-
| colspan="2" | Prints a string to the MIAC display starting from the current cursor position.&nbsp;
| colspan="2" | Prints a floating point number to the MIAC display starting from the current cursor position.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="90%" | data
| width="90%" | Value
|-
|-
| colspan="2" | Range: 0-21&nbsp;
| colspan="2" | Range: Float&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" | NumDP
|}
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| colspan="2" | Number of decimal places to display&nbsp;
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAPIVersion'''
|-
|-
| colspan="2" | Gets the API version of the MIAC NXT AllCode Firmware. Useful to see if the MIAC NXT is responding to commands.&nbsp;
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
|-
|-
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===DisplayNumber===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayNumber'''
| width="90%" class="mtx-class-macrohead" | '''DisplayNumber'''
|-
|-
| colspan="2" | Prints a number to the MIAC display starting from the current cursor position.&nbsp;
| colspan="2" | Prints a number to the MIAC display starting from the current cursor position.&nbsp;
Line 124: Line 146:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===DisplayPixel===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteTranPWMDuty'''
| width="90%" class="mtx-class-macrohead" | '''DisplayPixel'''
|-
|-
| colspan="2" | Sets the PWM duty on the selected channel.&nbsp;
| colspan="2" | Controls a single pixel on the MIAC display&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
| width="90%" | X
|-
|-
| colspan="2" | Range: 1-4 Where 1=A / 2=B / 3=C / 4=D&nbsp;
| colspan="2" | Range: 0-119&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | EnableOrState
| width="90%" | Y
|-
|-
| colspan="2" | 1 = Enable / 0 = State&nbsp;
| colspan="2" | Range: 0-31&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Duty
| width="90%" | State
|-
|-
| colspan="2" | &nbsp;
| colspan="2" | Range: 0-1&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 152: Line 175:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===DisplayPrint===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayClear'''
| width="90%" class="mtx-class-macrohead" | '''DisplayPrint'''
|-
| colspan="2" | Prints a string to the MIAC display starting from the current cursor position.&nbsp;
|-
|-
| colspan="2" | Clears the MIAC display&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | data
|-
| colspan="2" | Range: 0-21&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 165: Line 194:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===GetAPIVersion===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadKey'''
| width="90%" class="mtx-class-macrohead" | '''GetAPIVersion'''
|-
|-
| colspan="2" | Reads a keypress from the keypad. Returns 0 for no keypress or 1-9 for a valid keypress. 1 = TopLeft, 2=TopMiddle, 3=TopRight, 4=CenterLeft etc&nbsp;
| colspan="2" | Gets the API version of the MIAC NXT AllCode Firmware. Useful to see if the MIAC NXT is responding to commands.&nbsp;
|-
|-
|-
|-
Line 178: Line 208:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ReadAnalogInput===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayPixel'''
| width="90%" class="mtx-class-macrohead" | '''ReadAnalogInput'''
|-
|-
| colspan="2" | Controls a single pixel on the MIAC display&nbsp;
| colspan="2" | Reads a single analog input with range 0 to 4095 corresponding to input voltage 0V to +V.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | X
| width="90%" | Channel
|-
| colspan="2" | Range: 1 - 8&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''
|}
 
 
===ReadDigitalInput===
{| class="mtx-class-macrotable wikitable"
|-
|-
| colspan="2" | Range: 0-119&nbsp;
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadDigitalInput'''
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| colspan="2" | Reads a single digital input.&nbsp;
| width="90%" | Y
|-
|-
| colspan="2" | Range: 0-31&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | State
| width="90%" | Channel
|-
|-
| colspan="2" | Range: 0-1&nbsp;
| colspan="2" | Range: 1 - 8&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===ReadDigitalInputs===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteRelay'''
| width="90%" class="mtx-class-macrohead" | '''ReadDigitalInputs'''
|-
|-
| colspan="2" | Allows a single relay to be switched on or off.&nbsp;
| colspan="2" | Reads all digital inputs at once and returns as a binary value. Input 1 = Bit 0 Input 8 = Bit 7&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Channel
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
 
 
===ReadKey===
{| class="mtx-class-macrotable wikitable"
|-
|-
| colspan="2" | Range 1-2&nbsp;
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" class="mtx-class-macrohead" | '''ReadKey'''
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| colspan="2" | Reads a keypress from the keypad. Returns 0 for no keypress or 1-9 for a valid keypress. 1 = TopLeft, 2=TopMiddle, 3=TopRight, 4=CenterLeft etc&nbsp;
| width="90%" | Value
|-
|-
| colspan="2" | 0 = Off, 1 = On&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===SetAPIVerbose===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteRelays'''
| width="90%" class="mtx-class-macrohead" | '''SetAPIVerbose'''
|-
|-
| colspan="2" | Allows all relays to be switched on or off in a single command.&nbsp;
| colspan="2" | Controls the Verbose mode.  When enabled the LCD automatically displays an account of the incoming API commands and parameters. When switched off the LCD is free for the user to control as required.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Value
| width="90%" | Mode
|-
|-
| colspan="2" | Range: 0-3 or 0b00 to 0b11&nbsp;
| colspan="2" | Range: 0-1 : 0=Off or User Mode / 1=API Verbose Mode&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 247: Line 293:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===WriteRelay===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAnalogInput'''
| width="90%" class="mtx-class-macrohead" | '''WriteRelay'''
|-
|-
| colspan="2" | Reads a single analog input with range 0 to 4095 corresponding to input voltage 0V to +V.&nbsp;
| colspan="2" | Allows a single relay to be switched on or off.&nbsp;
|-
|-
|-
|-
Line 258: Line 305:
| width="90%" | Channel
| width="90%" | Channel
|-
|-
| colspan="2" | Range: 1 - 8&nbsp;
| colspan="2" | Range 1-2&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Value
|-
| colspan="2" | 0 = Off, 1 = On&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===WriteRelays===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAPIVerbose'''
| width="90%" class="mtx-class-macrohead" | '''WriteRelays'''
|-
|-
| colspan="2" | Controls the Verbose mode.  When enabled the LCD automatically displays an account of the incoming API commands and parameters. When switched off the LCD is free for the user to control as required.&nbsp;
| colspan="2" | Allows all relays to be switched on or off in a single command.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Mode
| width="90%" | Value
|-
|-
| colspan="2" | Range: 0-1 : 0=Off or User Mode / 1=API Verbose Mode&nbsp;
| colspan="2" | Range: 0-3 or 0b00 to 0b11&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 283: Line 336:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===WriteTran===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayCursor'''
| width="90%" class="mtx-class-macrohead" | '''WriteTran'''
|-
|-
| colspan="2" | Sets the cursor position for the MIAC display&nbsp;
| colspan="2" | Allows a single transistor output to be switched on or off.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | X
| width="90%" | Channel
|-
|-
| colspan="2" | Range: 0-21&nbsp;
| colspan="2" | Range 1-6 where 1=A / 2=B / 3=C / 4=D / 5=E / 6=F&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Y
| width="90%" | Value
|-
|-
| colspan="2" | Range: 0-3&nbsp;
| colspan="2" | 0 = Off, 1 = On&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 306: Line 360:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===WriteTranPWMDuty===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDigitalInput'''
| width="90%" class="mtx-class-macrohead" | '''WriteTranPWMDuty'''
|-
|-
| colspan="2" | Reads a single digital input.&nbsp;
| colspan="2" | Sets the PWM duty on the selected channel.&nbsp;
|-
|-
|-
|-
Line 317: Line 372:
| width="90%" | Channel
| width="90%" | Channel
|-
|-
| colspan="2" | Range: 1 - 8&nbsp;
| colspan="2" | Range: 1-4 Where 1=A / 2=B / 3=C / 4=D&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
| width="90%" | EnableOrState
|}
 
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| colspan="2" | 1 = Enable / 0 = State&nbsp;
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDigitalInputs'''
|-
|-
| colspan="2" | Reads all digital inputs at once and returns as a binary value. Input 1 = Bit 0 Input 8 = Bit 7&nbsp;
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | Duty
|-
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===WriteTranPWMEnable===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteTran'''
| width="90%" class="mtx-class-macrohead" | '''WriteTranPWMEnable'''
|-
|-
| colspan="2" | Allows a single transistor output to be switched on or off.&nbsp;
| colspan="2" | Allows pulse width modulated transistor outputs to be switched on or off.&nbsp;
|-
|-
|-
|-
Line 348: Line 401:
| width="90%" | Channel
| width="90%" | Channel
|-
|-
| colspan="2" | Range 1-6 where 1=A / 2=B / 3=C / 4=D / 5=E / 6=F&nbsp;
| colspan="2" | Range: 1-4 Where 1=A / 2=B / 3=C / 4=D&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | EnableOrState
|-
| colspan="2" | PWM on Enable Pin or State Pin - 1 = Enable / 0 = State&nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | Value
| width="90%" | OnOrOff
|-
|-
| colspan="2" | 0 = Off, 1 = On&nbsp;
| colspan="2" | 1 = Enabled / 0 = Disabled&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 360: Line 418:




{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
===WriteTrans===
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayFloat'''
| width="90%" class="mtx-class-macrohead" | '''WriteTrans'''
|-
|-
| colspan="2" | Prints a floating point number to the MIAC display starting from the current cursor position.&nbsp;
| colspan="2" | Allows all transistor outputs to be switched on or off in a single command.&nbsp;
|-
|-
|-
|-
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Value
| width="90%" | Value
|-
|-
| colspan="2" | Range: Float&nbsp;
| colspan="2" | Range: 0-63 or 0b000000 to 0b111111&nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | NumDP
|-
| colspan="2" | Number of decimal places to display&nbsp;
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| 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''
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}
|}




==Property reference==
==Property reference==


{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
| width="90%" class="mtx-class-propfolder" | Connections
|-
|-
|-
|-
Line 407: Line 459:
| colspan="2" | Generates a warning dialogue if the communication to the device fails allowing the program to be ended.&nbsp;
| colspan="2" | Generates a warning dialogue if the communication to the device fails allowing the program to be ended.&nbsp;
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connection Properties
| width="90%" class="mtx-class-propfolder" | Connection Properties
|-
|-
|-
|-

Latest revision as of 14:36, 13 July 2026

Author Matrix TSL
Version 1.1
Category AllCode


MIAC NXT AllCode API component

Controls the MIAC NXT hardware loaded with the MIAC NXT AllCode firmware. Usefull for SCADA, Control or Test applications. Compatible with USB / Bluetooth / Wifi / Ethernet

Component Source Code

Please click here to download the component source project: FC_Comp_Source_MIAC_NXT_AllCode_Component_Source.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_MIAC_NXT_AllCode_Component_Source.fcsx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples






Macro reference

DisplayClear

DisplayClear
Clears the MIAC display 
- VOID Return


DisplayCursor

DisplayCursor
Sets the cursor position for the MIAC display 
- BYTE X
Range: 0-21 
- BYTE Y
Range: 0-3 
- VOID Return


DisplayFloat

DisplayFloat
Prints a floating point number to the MIAC display starting from the current cursor position. 
- FLOAT Value
Range: Float 
- BYTE NumDP
Number of decimal places to display 
- VOID Return


DisplayNumber

DisplayNumber
Prints a number to the MIAC display starting from the current cursor position. 
- LONG Value
Range: Signed Long 
- VOID Return


DisplayPixel

DisplayPixel
Controls a single pixel on the MIAC display 
- BYTE X
Range: 0-119 
- BYTE Y
Range: 0-31 
- BOOL State
Range: 0-1 
- VOID Return


DisplayPrint

DisplayPrint
Prints a string to the MIAC display starting from the current cursor position. 
- STRING data
Range: 0-21 
- VOID Return


GetAPIVersion

GetAPIVersion
Gets the API version of the MIAC NXT AllCode Firmware. Useful to see if the MIAC NXT is responding to commands. 
- BYTE Return


ReadAnalogInput

ReadAnalogInput
Reads a single analog input with range 0 to 4095 corresponding to input voltage 0V to +V. 
- BYTE Channel
Range: 1 - 8 
- UINT Return


ReadDigitalInput

ReadDigitalInput
Reads a single digital input. 
- BYTE Channel
Range: 1 - 8 
- BYTE Return


ReadDigitalInputs

ReadDigitalInputs
Reads all digital inputs at once and returns as a binary value. Input 1 = Bit 0 Input 8 = Bit 7 
- BYTE Return


ReadKey

ReadKey
Reads a keypress from the keypad. Returns 0 for no keypress or 1-9 for a valid keypress. 1 = TopLeft, 2=TopMiddle, 3=TopRight, 4=CenterLeft etc 
- BYTE Return


SetAPIVerbose

SetAPIVerbose
Controls the Verbose mode. When enabled the LCD automatically displays an account of the incoming API commands and parameters. When switched off the LCD is free for the user to control as required. 
- BOOL Mode
Range: 0-1 : 0=Off or User Mode / 1=API Verbose Mode 
- VOID Return


WriteRelay

WriteRelay
Allows a single relay to be switched on or off. 
- BYTE Channel
Range 1-2 
- BOOL Value
0 = Off, 1 = On 
- VOID Return


WriteRelays

WriteRelays
Allows all relays to be switched on or off in a single command. 
- BYTE Value
Range: 0-3 or 0b00 to 0b11 
- VOID Return


WriteTran

WriteTran
Allows a single transistor output to be switched on or off. 
- BYTE Channel
Range 1-6 where 1=A / 2=B / 3=C / 4=D / 5=E / 6=F 
- BOOL Value
0 = Off, 1 = On 
- VOID Return


WriteTranPWMDuty

WriteTranPWMDuty
Sets the PWM duty on the selected channel. 
- BYTE Channel
Range: 1-4 Where 1=A / 2=B / 3=C / 4=D 
- BOOL EnableOrState
1 = Enable / 0 = State 
- UINT Duty
 
- VOID Return


WriteTranPWMEnable

WriteTranPWMEnable
Allows pulse width modulated transistor outputs to be switched on or off. 
- BYTE Channel
Range: 1-4 Where 1=A / 2=B / 3=C / 4=D 
- BOOL EnableOrState
PWM on Enable Pin or State Pin - 1 = Enable / 0 = State 
- BOOL OnOrOff
1 = Enabled / 0 = Disabled 
- VOID Return


WriteTrans

WriteTrans
Allows all transistor outputs to be switched on or off in a single command. 
- BYTE Value
Range: 0-63 or 0b000000 to 0b111111 
- VOID Return


Property reference

Properties
Connections
API Connection Type
API connection mode. COM - Bluetooth / RS232 / RS485 WIFI - Network 
Warnings On Error
Generates a warning dialogue if the communication to the device fails allowing the program to be ended. 
Connection Properties
Auto Detect
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_MIAC_NXT_AllCode_API_(AllCode)&oldid=47902"