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 depending on the board configuration. |
| 11 | relays.cgi?off=x | relays.cgi?off=x | Turns off relay ‘x’, x varies from 0 – 9 , A – V, 000-031 depending on the board configuration. |
| 12 | relays.cgi?read=x | relays.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 | gpios.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 | gpios.cgi?gpioclear= | Clear gpio x. x varies from 0 – 9 , A – V, 000-031 depending on the board configuration. |
| 17 | gpio.cgi?read=x | gpioread.cgi?gpio=5 | Reads gpio x. x varies from 0 – 9 , A – V, 000-031 depending on the board configuration. |
| 18 | gpiol.cgi?writeall=[value] | gpiowriteall.cgi?gpiowriteall=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] | iomask.cgi?iomask=ff | 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] | iodir.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 | gpioreadall.cgi | This command reads status of all gpio. |
| 23 | adc.cgi?read=x | adcread.cgi?adc=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. |
Refer product page and user manual to know more about the number of relays/GPIOs/analog pins.
Note:
- “gpio – set, clear, status and adc read” commands are not Present on PoE Relay & PoE GPI modules.
- “gpio – iodir and iomask” are not Present on ETH Relay, PoE Relay and PoE GPI/GPO modules.
- “adcread” commands are not present on PoE GPIO 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.
- Prefex IP Address before all commands. Eg: 192.168.1.1/ver.cgi