This document describes the command sets used on the Numato Lab Ethernet/PoE Modules.
| Sl. No. | Command | Usage | Description |
|---|---|---|---|
| 1 | info.cgi | info.cgi | Displays the info data of the module. |
| 2 | ver.cgi | ver.cgi | Displays the firmware version. |
| 3 | idget.cgi | idget.cgi | Reads the Device ID. |
| 4 | usrget.cgi | usrget.cgi | Reads the username. |
| 5 | passget.cgi | passget.cgi | Reads the password. |
| 6 | reset.cgi | reset.cgi | Reset all the relays to off state. |
| 7 | modulereboot.cgi | modulereboot.cgi | Reboots the module to configuration mode. |
| 8 | id.cgi?devid=[device id] | id.cgi?devid=00000001 | Set new Device ID. Device ID must be 8 in length. |
| 9 | settings.cgi?cred=[username] [password] | settings.cgi?cred=numato numato | Set new Username and Password. Enter the username and password accordingly. User name and password can be of length 1-8. |
| 10 | relay.cgi?on=x | relay.cgi?on=x | Turns on relay ‘x’, x varies from 0 – 9 & A – V, 000 - 031 depending on the board configuration. |
| 11 | relay.cgi?off=x | relay.cgi?off=x | Turns off relay ‘x’, x varies from 0 – 9 , A – V, 000-031 depending on the board configuration. |
| 12 | relay.cgi?read=x | relay.cgi?read=x | Reads the state of relay ‘x’, x varies from 0 – 9 , A – V, 000-031 depending on the board configuration. |
| 13 | relay.cgi?writeall=[value] | relay.cgi?writeall=[value] | On/off multiple relays at a time Note: value is in hexadecimal from 00 to ffffffff depending on the number of relays onboard. |
| 14 | relay.cgi?readall | relay.cgi?readall | Read all relays status in hexadecimal value. |
| 15 | gpio.cgi?set=x | gpio.cgi?gpioset=0 | Set gpio x. x varies from 0 – 9 , A – V, 000-031 depending on the board configuration. |
| 16 | gpio.cgi?clear=x | gpio.cgi?gpioclear= | Clear gpio x. x varies from 0 – 9 , A – V, 000-031 depending on the board configuration. |
| 17 | gpio.cgi?read=x | gpio.cgi?read=5 | Reads gpio x. x varies from 0 – 9 , A – V, 000-031 depending on the board configuration. |
| 18 | gpio.cgi?writeall=[value] | gpio.cgi?writeall=ffff | Set/clear multiple gpios at a time. Note: value is in hexadecimal from 00 to ffffffff depending on the number of GPIOs onboard. |
| 19 | gpio.cgi?iomask=[value] | gpio.cgi?iomask=ffff | This command masks the GPIOs in GPIO modules from changing the state.. Note: value is in hexadecimal from 00 to ffffffff depending on the number of GPIOs onboard. 0 – mask & 1 – unmask |
| 20 | gpio.cgi?iodir=[value] | gpio.cgi?iodir=ffff | Set the Input/output direction of the GPIOs. Note: value is in hexadecimal from 00 to ffffffff depending on the number of GPIOs onboard. 0 – Output & 1 – Input. |
| 21 | gpio.cgi?status=x | gpio.cgi?status=x | Reads gpio x status withput changing it's IO direction. x varies from 0 – 9 , A – V, 000-031 depending on the board configuration. |
| 22 | gpio.cgi?readall | gpio.cgi?readall | This command reads status of all gpio. |
| 23 | adc.cgi?read=x | adc.cgi?read=0 | This command reads adc value at pin x. x varies from 0 – 9 , A – D, 000-013 depending on the board configuration and only if Analog inputs available onboard. |
| 24 | adc.cgi?rangeset=x X | adc.cgi?rangeset=000 2 | This command sets the adc pin x to a range X. x varies from 000 - 003 and X varies from 0 to 8. |
| 25 | adc.cgi?rangeget=x | adc.cgi?rangeget=000 | Reads the adc x range. x varies from 000 - 003. |
| 26 | adc.cgi?offsetset=x z X | adc.cgi?offsetset=000 0 500 | This command adds/subtracts the offset value X based on the z value to the ADC value of pin x. x varies from 000 - 003, z: 0 - adds, 1 - subtracts, X varies from 0 to 9999. |
| 27 | adc.cgi?offsetget=x | adc.cgi?offsetget=000 | Reads the adc x's offset set value with the sign. x varies from 000 - 003. |
| 28 | adc.cgi?configset=x | adc.cgi?configset=1 | Sets the x value to the ADC's. Note: x is in hexdecimal from 0 to f depending on the number of ADCs onboard. 0 - Voltage loop & 1 - Current loop. |
| 29 | adc.cgi?configget | adc.cgi?configget | Reads the ADC's config value. The output read is a hexadecimal value. |
| 30 | dac.cgi?set=x X | dac.cgi?set=000 1 | Set DAC x to X volts. x varies from 000-003, X varies from 0.00 to 10.0 |
| 31 | dac.cgi?read=x | dac.cgi?read=000 | Reads DAC x. x varies from 000-003. |
Refer product page and user manual to know more about the number of relays/GPIOs/ADCs/DACs.
Note:
- “gpio – set, clear and status” commands are not Present on PoE Relay, PoE GPI & ETH ADC-DAC modules.
- “gpio – iodir and iomask” are not Present on ETH Relay/ADC-DAC, PoE Relay and PoE GPI/GPO modules.
- “adc read” commands are not present on PoE Relay & PoE GPIO modules.
- “adc – rangeset, rangeget, offsetset, offsetget, configset and configget” commands are only present on ETH ADC-DAC(DAQ) version – A0M01.02 modules.
- “relay – on, off, readall, writeall, reset” commands are only present on Relay modules.
- “gpio – writeall, readall” command are present only on ETH GPIO and PoE GPIO modules
- “gpio – iomask, iodir” commands are present only on ETH GPIO modules.
- “dac – set, read” commands are present only on ETH ADC-DAC modules.
- “info” command is not present on ETH ADC-DAC A0M01.01 version.
- Prefex IP Address before all commands. Eg: 192.168.1.1/ver.cgi