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

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

@@ Line 69: / Line 69: @@
 |-
 | 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" | '''DisplayClear'''
 |-
 | colspan="2" | Clears the MIAC display&nbsp;
@@ Line 83: / Line 83: @@
 |-
 | 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" | '''DisplayCursor'''
 |-
 | colspan="2" | Sets the cursor position for the MIAC display&nbsp;
@@ Line 107: / Line 107: @@
 |-
 | 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" | '''DisplayFloat'''
 |-
 | colspan="2" | Prints a floating point number to the MIAC display starting from the current cursor position.&nbsp;
@@ Line 131: / Line 131: @@
 |-
 | 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;
@@ Line 150: / Line 150: @@
 |-
 | 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" | '''DisplayPixel'''
 |-
 | colspan="2" | Controls a single pixel on the MIAC display&nbsp;
@@ Line 179: / Line 179: @@
 |-
 | 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" | '''DisplayPrint'''
 |-
 | colspan="2" | Prints a string to the MIAC display starting from the current cursor position.&nbsp;
@@ Line 198: / Line 198: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAPIVersion'''
+| width="90%" class="mtx-class-macrohead" | '''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;
@@ Line 212: / Line 212: @@
 |-
 | 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" | '''ReadAnalogInput'''
 |-
 | colspan="2" | Reads a single analog input with range 0 to 4095 corresponding to input voltage 0V to +V.&nbsp;
@@ Line 231: / Line 231: @@
 |-
 | 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" | '''ReadDigitalInput'''
 |-
 | colspan="2" | Reads a single digital input.&nbsp;
@@ Line 250: / Line 250: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadDigitalInputs'''
+| width="90%" class="mtx-class-macrohead" | '''ReadDigitalInputs'''
 |-
 | colspan="2" | Reads all digital inputs at once and returns as a binary value. Input 1 = Bit 0 Input 8 = Bit 7&nbsp;
@@ Line 264: / Line 264: @@
 |-
 | 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" | '''ReadKey'''
 |-
 | 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;
@@ Line 278: / Line 278: @@
 |-
 | 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" | '''SetAPIVerbose'''
 |-
 | 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;
@@ Line 297: / Line 297: @@
 |-
 | 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" | '''WriteRelay'''
 |-
 | colspan="2" | Allows a single relay to be switched on or off.&nbsp;
@@ Line 321: / Line 321: @@
 |-
 | 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" | '''WriteRelays'''
 |-
 | colspan="2" | Allows all relays to be switched on or off in a single command.&nbsp;
@@ Line 340: / Line 340: @@
 |-
 | 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" | '''WriteTran'''
 |-
 | colspan="2" | Allows a single transistor output to be switched on or off.&nbsp;
@@ Line 364: / Line 364: @@
 |-
 | 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" | '''WriteTranPWMDuty'''
 |-
 | colspan="2" | Sets the PWM duty on the selected channel.&nbsp;
@@ Line 393: / Line 393: @@
 |-
 | 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" | '''WriteTranPWMEnable'''
 |-
 | colspan="2" | Allows pulse width modulated transistor outputs to be switched on or off.&nbsp;
@@ Line 422: / Line 422: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteTrans'''
+| width="90%" class="mtx-class-macrohead" | '''WriteTrans'''
 |-
 | colspan="2" | Allows all transistor outputs to be switched on or off in a single command.&nbsp;
@@ Line 442: / Line 442: @@
 |-
 | 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 459: / Line 459: @@
 | 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
 |-
 |-

SteveT (talk | contribs)