Difference between revisions of "Component: MIAC NXT AllCode API (AllCode)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/MIAC_NXT_AllCode_Component_Source.fcsx FC_Comp_Source_temp/MIAC_NXT_AllCode_Component_Source.fcsx] |
| − | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/ | + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/MIAC_NXT_AllCode_Component_Source.fcsx FC_Comp_Source_temp/MIAC_NXT_AllCode_Component_Source.fcsx] |
==Detailed description== | ==Detailed description== | ||
| Line 52: | Line 52: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| + | |||
| + | |||
| Line 59: | Line 61: | ||
==Macro reference== | ==Macro reference== | ||
| − | === | + | ===DisplayClear=== |
| + | {| 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;" | '''DisplayClear''' | ||
| + | |- | ||
| + | | colspan="2" | Clears the MIAC display | ||
| + | |- | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | ===DisplayCursor=== | ||
| + | {| 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;" | '''DisplayCursor''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the cursor position for the MIAC display | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | X | ||
| + | |- | ||
| + | | colspan="2" | Range: 0-21 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Y | ||
| + | |- | ||
| + | | colspan="2" | Range: 0-3 | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | ===DisplayFloat=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayFloat''' |
| + | |- | ||
| + | | colspan="2" | Prints a floating point number to the MIAC display starting from the current cursor position. | ||
| + | |- | ||
|- | |- | ||
| − | | | + | | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT |
| + | | width="90%" | Value | ||
|- | |- | ||
| + | | colspan="2" | Range: Float | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| − | | width="90%" | | + | | width="90%" | NumDP |
| + | |- | ||
| + | | colspan="2" | Number of decimal places to display | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | ===DisplayNumber=== | ||
| + | {| 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;" | '''DisplayNumber''' | ||
|- | |- | ||
| − | | | + | | colspan="2" | Prints a number to the MIAC display starting from the current cursor position. |
| − | |||
|- | |- | ||
| − | |||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG |
| − | | width="90%" | | + | | width="90%" | Value |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Range: Signed Long |
|- | |- | ||
| 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 88: | Line 142: | ||
| − | === | + | ===DisplayPixel=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DisplayPixel''' |
| + | |- | ||
| + | | colspan="2" | Controls a single pixel on the MIAC display | ||
| + | |- | ||
|- | |- | ||
| − | | | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| + | | width="90%" | X | ||
|- | |- | ||
| + | | colspan="2" | Range: 0-119 | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| − | | width="90%" | | + | | width="90%" | Y |
| + | |- | ||
| + | | colspan="2" | Range: 0-31 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | State | ||
|- | |- | ||
| − | | colspan="2" | Range: 0- | + | | colspan="2" | Range: 0-1 |
|- | |- | ||
| 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 140: | Line 204: | ||
| − | === | + | ===ReadAnalogInput=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadAnalogInput''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Reads a single analog input with range 0 to 4095 corresponding to input voltage 0V to +V. |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| − | | width="90%" | | + | | width="90%" | Channel |
|- | |- | ||
| − | | colspan="2" | Range: | + | | colspan="2" | Range: 1 - 8 |
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | === | + | ===ReadDigitalInput=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDigitalInput''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Reads a single digital input. |
|- | |- | ||
|- | |- | ||
| Line 171: | Line 235: | ||
| width="90%" | Channel | | width="90%" | Channel | ||
|- | |- | ||
| − | | colspan="2" | Range: 1- | + | | colspan="2" | Range: 1 - 8 |
|- | |- | ||
| − | + | | 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- | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
| − | === | + | ===ReadDigitalInputs=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDigitalInputs''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Reads all digital inputs at once and returns as a binary value. Input 1 = Bit 0 Input 8 = Bit 7 |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | + | | 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'' | ||
|} | |} | ||
| Line 216: | Line 270: | ||
| − | === | + | ===SetAPIVerbose=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAPIVerbose''' |
|- | |- | ||
| − | | colspan="2" | Controls | + | | 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. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| − | | width="90%" | | + | | width="90%" | Mode |
|- | |- | ||
| − | | colspan="2" | Range: 0-1 | + | | colspan="2" | Range: 0-1 : 0=Off or User Mode / 1=API Verbose Mode |
|- | |- | ||
| 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 288: | Line 332: | ||
| − | === | + | ===WriteTran=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteTran''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Allows a single transistor output to be switched on or off. |
|- | |- | ||
|- | |- | ||
| Line 300: | Line 344: | ||
| width="90%" | Channel | | width="90%" | Channel | ||
|- | |- | ||
| − | | colspan="2" | Range | + | | colspan="2" | Range 1-6 where 1=A / 2=B / 3=C / 4=D / 5=E / 6=F |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| − | | width="90%" | | + | | width="90%" | Value |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | 0 = Off, 1 = On |
|- | |- | ||
| 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 326: | Line 356: | ||
| − | === | + | ===WriteTranPWMDuty=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteTranPWMDuty''' |
|- | |- | ||
| − | | colspan="2" | Sets the | + | | colspan="2" | Sets the PWM duty on the selected channel. |
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| − | | width="90%" | | + | | width="90%" | Channel |
| + | |- | ||
| + | | colspan="2" | Range: 1-4 Where 1=A / 2=B / 3=C / 4=D | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | width="90%" | EnableOrState | ||
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | 1 = Enable / 0 = State |
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT |
| − | | width="90%" | | + | | width="90%" | Duty |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | |
|- | |- | ||
| 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 350: | Line 385: | ||
| − | === | + | ===WriteTranPWMEnable=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteTranPWMEnable''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Allows pulse width modulated transistor outputs to be switched on or off. |
|- | |- | ||
|- | |- | ||
| Line 362: | Line 397: | ||
| width="90%" | Channel | | width="90%" | Channel | ||
|- | |- | ||
| − | | colspan="2" | Range: 1 - | + | | colspan="2" | Range: 1-4 Where 1=A / 2=B / 3=C / 4=D |
|- | |- | ||
| − | | width="10%" align="center | + | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL |
| − | | width="90%" | + | | width="90%" | EnableOrState |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| − | + | | colspan="2" | PWM on Enable Pin or State Pin - 1 = Enable / 0 = State | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | | colspan="2" | | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| − | | width="90%" | | + | | width="90%" | OnOrOff |
|- | |- | ||
| − | | colspan="2" | 0 = | + | | colspan="2" | 1 = Enabled / 0 = Disabled |
|- | |- | ||
| 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 407: | Line 414: | ||
| − | === | + | ===WriteTrans=== |
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| − | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | ''' | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteTrans''' |
|- | |- | ||
| − | | colspan="2" | | + | | colspan="2" | Allows all transistor outputs to be switched on or off in a single command. |
|- | |- | ||
|- | |- | ||
| − | | width="10%" align="center" | [[File:Fc9- | + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE |
| width="90%" | Value | | width="90%" | Value | ||
|- | |- | ||
| − | | colspan="2" | Range: | + | | colspan="2" | Range: 0-63 or 0b000000 to 0b111111 |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| 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 | ||
Revision as of 12:02, 3 February 2023
| Author | Matrix TSL |
| Version | 1.1 |
| Category | AllCode |
Contents
- 1 MIAC NXT AllCode API component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 DisplayClear
- 5.2 DisplayCursor
- 5.3 DisplayFloat
- 5.4 DisplayNumber
- 5.5 DisplayPixel
- 5.6 DisplayPrint
- 5.7 GetAPIVersion
- 5.8 ReadAnalogInput
- 5.9 ReadDigitalInput
- 5.10 ReadDigitalInputs
- 5.11 ReadKey
- 5.12 SetAPIVerbose
- 5.13 WriteRelay
- 5.14 WriteRelays
- 5.15 WriteTran
- 5.16 WriteTranPWMDuty
- 5.17 WriteTranPWMEnable
- 5.18 WriteTrans
- 6 Property reference
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_temp/MIAC_NXT_AllCode_Component_Source.fcsx
Please click here to view the component source code (Beta): FC_Comp_Source_temp/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 |
