ECMD Reference

From Ethersex Wiki
Jump to: navigation, search

This page is automatically generated from the files in the Ethersex source code repository. Do not edit this page but send patches for those files!






DNS Resolver

Command syntax Short description
dns server [IPADDR] Display/Set the IP address of the DNS server to use to IPADDR.
nslookup HOSTNAME Do DNS lookup for HOSTNAME (call twice).

Digital/Analog Conversion (DAC)

Command syntax Short description
ltc1257_delay `[VALUE] Set (if VALUE given) or get (no VALUE) delay for LTC1257 output bit changes in µs'
ltc1257_set `[VALUE0] [VALUE1] ... Set output to value (value: 0-4095)'
tlc5620 `[CHANNEL] [VALUE] Set Output to value (Value: 0-0xff)'

Fnordlicht

Command syntax Short description
fnordlicht "ADDRESS RED GREEN,BLUE",fnordlicht command to set RGB color
fnordlicht_init fnordlicht init

HD44780 LCD

Command syntax Short description
hr20 hourbar START STOP Update hourbar to show ticks between START and STOP (range 0..23)
hr20 toggle SEG Toggle segment SEG (a number, not a symbolic name!)
lcd backlight [STATE] get or set the state of the lcd backlight
lcd char N D1 D2 D3 D4 D5 D6 D7 D8 Define use-definable char N with data D1..D8 (provide DATA in hex)
lcd clear [LINE] Clear line LINE (0..3) or the whole display (if parameter is omitted)
lcd goto LINE COL Move cursor to LINE and column COL (origin is 0/0)
lcd reinit CURSOR BLINK Reinitialize the display, set whether to show the cursor (CURSOR, 0 or 1) and whether the cursor shall BLINK
lcd shift DIR Shift the display to DIR (either left or right)
lcd write TEXT Write TEXT to the current cursor location

Infrared Send/Receive (IRMP)

Command syntax Short description
irmp receive receive an IR command
irmp send PROTOCOL DEVICE COMMAND REPEAT send COMMAND with REPEAT flag to DEVICE using PROTOCOL

Infrared Send/Receive (RC5)

Command syntax Short description
ir receive receive an IR command
ir send DEVICE COMMAND send COMMAND to DEVICE

Miscellaneous

Command syntax Short description
periodic adjust OFFSET Adjust periodic timers TOP value by adding OFFSET ticks.
periodic reset Reset debug statistics for periodic module.
periodic stats Print debug statistics for periodic module.

NTP Client

Command syntax Short description
ntp query Query the NTP server to get an NTP update.
ntp server [IPADDR] Display/Set the IP address of the NTP server to use to IPADDR.
ntp status Display NTP server status

Network configuration

Command syntax Short description
enc dump Dump the internal state of the enc to serial
gw [IP] Display/Set the address of the default router.
ip [IP] Display/Set the IP address.
mac [xx:xx:xx:xx:xx:xx] Display/Set the MAC address.
netmask [IP] Display/Set the network mask.

Port I/O

Command syntax Short description
io get ddr PORTNUM Display the current value of the DDR PORTNUM.
io get mask PORTNUM Display the mask of the port PORTNUM.
io get pin PORTNUM Display the current value of the PIN-register of the port PORTNUM.
io get port NUM Display the current value of the PORT NUM.
io set ddr PORTNUM HEXVALUE [MASK] Set the DDR of port PORTNUM to VALUE (possibly using the provided MASK).
io set port NUM HEXVALUE [MASK] Set the PORT NUM to VALUE (possibly using the provided MASK).

Reading and Writing EEPROM Space on Device

Command syntax Short description
eer eer <ADDR> <LENGTH> Read n bytes from address after the config in eeprom.
eew eew <ADDR> <HEXBYTES> Write Hexbytes at address after the config in epprom.
hostname Display hostname.

Resetting the controller

Command syntax Short description
bootloader Call the bootloader.
reset Reset the Ethersex.
wdreset Go into endless loop to trigger a watchdog timeout.

ADS

Command syntax Short description
ads get Get the ADC value in hex.
ads mean [COUNT] Get the mean of power of 2 COUNT ADC values in hex.
fuse Display current fuse settings

ASK

Command syntax Short description
ask 1527 HOUSECODE COMMAND DELAY CNT
ask 2272 HOUSECODE COMMAND [DELAY] [CNT] [SYNC]
ask fa20rf DEVICE [REPEAT]
ask intertechno FAMILY GROUP DEVICE COMMAND "Send Command to Intertechno switches (with coding wheel). FAMILY: A=1, ..."
ask itsl HOUSECODE COMMAND BUTTON [DIM] "Send Command to Intertechno Self learning switches and dimmers. DIM works only with dimmers and values 0-15."
ask oase FAMILY GROUP DEVICE COMMAND
ask tevion HOUSECODE COMMAND DELAY CNT

Clock

Command syntax Short description
date Print the current date.
lastdcf Print when last valid DCF signal was received.
time [UNIXTIME] Display/Set the current time in seconds since January 1st 1970.
uptime Display ethersex uptime in unix format.
whm Display ethersex uptime.

Application_Sample

Command syntax Short description
sample Manually call application sample commands
sample_init Manually call application sample init method
sample_periodic Manually call application sample periodic method

BSBPORT commands

Command syntax Short description
bsbport get P1 P2 P3 P4 SRC TYPE Show specific message currently in buffer format value as TYPE type is one of RAW STA TMP FP1 FP5
bsbport list List all messages currently in buffer output in RAW TMP FP1 FP5
bsbport query P1 P2 P3 P4 [DEST] Send Message to query for a value DEST is optional defaults to 0
bsbport set P1 P2 P3 P4 DEST TYPE VALUE Send Message to set value type is one of RAW SEL TMP FP1 FP5
bsbport stats Report statistic counters OK/CRC/Lenght under/Lenght over/Droped/Buffer/BufferNet/Retransmit

MCUF

Command syntax Short description
mcuf modul N Select module N
mcuf modul list List all modules
mcuf showclock Show digital clock
mcuf showstring MESSAGE Show scrolling MESSAGE on the display

CRC

Command syntax Short description
adc get [CHANNEL] Get the ADC value in hex of CHANNEL or if no channel set of all channels.
adc vget [CHANNEL] Get the ADC value in volt of CHANNEL or if no channel set of all channels.
adc vref [VOLTAGE] Get/Set ADC reference voltage calibration.
crc calc "read the ethersex program code and calc a crc16 of it"
crc read "read out the crc16 value at the end of the program space"
hr20 temp Read HR20 temperature sensor.

CRON-Dienst

Command syntax Short description
cron add MIN HOUR DAY MONTH DOW ECMD Add ECMD to cron to be executed at given time
cron anacron POSITION [STATE] show/set job anacron state
cron list Show all cron entries
cron persistent POSITION [STATE] show/set job persistance state
cron rm [POSITION] Remove one cron entry
cron save Saves all persistent jobs
cron utc POSITION [STATE] show/set utc state

DALI

Command syntax Short description
dali cmd [TARGET] [COMMAND] [!][?] "send the given command (decimal) to targets (all, g00 to g15, s00 to s63), auto repeat with !, read reply with ?"
dali dim [TARGET] [LEVEL] "dim targets (all, g00 to g15, s00 to s63) to given level (0-254)"
dali raw [BYTE1] [BYTE2] "send a raw frame (two bytes, given in hex) over the DALI bus"
dali scmd [SPECIAL COMMAND] [DATA] [!][?] "send special command (256-287) with data, auto repeat with !, read reply with ?"

DHT

Command syntax Short description
dht humid [SENSORNUMBER] Return humidity of DHT sensor
dht list Return a list of mapped sensor names
dht temp [SENSORNUMBER] Return temperature of DHT sensor

DMX_FXSlot commands

Command syntax Short description
dmx fxslot devices set the device settings
dmx fxslot effect set the effect settings
dmx fxslot reset reset all fxslots and clear saved ones in EEPROM
dmx fxslot restore restore the settings from EEPROM
dmx fxslot save save the current fxslots to EEPROM

DMX_Storage commands

Command syntax Short description
dmx channels Get channels per universe
dmx get Return channel value
dmx set Set channel values
dmx universe Get a whole universe
dmx universes Get universes

Dallas_1-wire_Bus

Command syntax Short description
1w convert DEVICE Trigger temperature conversion of either DEVICE or all connected devices
1w ds2450 convert [DEVICE] `start conversion (with optional input mask and read out control)'
1w ds2450 get [DEVICE] `get conversion result (one or all channels)'
1w ds2450 oc [DEVICE] `get/set output control (per channel)'
1w ds2450 oe [DEVICE] `get/set output enable (per channel)'
1w ds2450 por [DEVICE] `get/set power on reset (per channel)'
1w ds2450 power [DEVICE] `get/set power supply of device (global)'
1w ds2450 range [DEVICE] `get/set input voltage range (per channel)'
1w ds2450 res [DEVICE] `get/set bit resolution of AD convert (per channel)'
1w get DEVICE Return temperature value of onewire device (provide 64-bit ID as 16-hex-digits)
1w list Return a list of the connected onewire devices
1w name clear ID Delete a name mapping
1w name list Return a list of mapped device names
1w name save Save name mappings to EEPROM
1w name set ID DEVICE NAME Assign a name to/from an device address

DataFlash

Command syntax Short description
df status Display internal status.
fs format Format the filesystem.
fs inspect inode INODE Inspect INODE (and associated page).
fs inspect node NODE Inspect NODE and dump to serial.
fs list List the directory.
fs mkfile NAME Create a new file NAME.
fs remove NAME Delete the file NAME.
fs truncate NAME LEN Truncate the file NAME to LEN bytes.

DC3840 mobil camera support

Command syntax Short description
dc3840 capture Take a picture. Access 'dc3840' via VFS afterwards. See DC3840 Camera for details.
dc3840 light Light level of camera
dc3840 send A B C D E Send provided command bytes to the camera.
dc3840 sync Re-sync to the camera
dc3840 zoom Enable zoom of camera

ECMDScript

Command syntax Short description
call FILENAME Start script named FILENAME
cat FILENAME cat file content (with debug only)
dec VAR Decrement variable VAR (a number)
echo <any> Print out all arguments of echo
exit Exit currently running script
get VAR Get value of variable VAR
goto N Goto line N in currently running script
if ( CMD/VAR == CONST ) then CMD2 If condition matches execute CMD2
inc VAR Increment variable VAR (a number)
rem <any> Remark for anything
set VAR VALUE Set variable VAR to VALUE
wait I Wait I milliseconds

FS20

Command syntax Short description
fht send HOUSECODE ADDR CMD [CMD2] Send FHT command. See FS20 for details.
fs20 receive Receive FS20/FHT sequence and display it.
fs20 send HOUSECODE ADDR CMD [CMD2] Send FS20 command. See FS20 for details.
fs20 ws300 Receive FS20 sequence from WS300 weather station and decode it.

Frequency Counter

Command syntax Short description
fc %duty [CHANNEL] "returns last on duty cycle in percent for given channel"
fc duty [CHANNEL] "returns last on duty cycle (0-255) for given channel"
fc freq [CHANNEL] "returns last frequency in Hz for given channel"
fc off [CHANNEL] "switch off frequency counting on given channel"
fc on [CHANNEL] "switch on frequency counting on given channel"
fc ticks [CHANNEL] "returns last frequency in CPU ticks for given channel"

GLCD_Menu

Command syntax Short description
glcdmenu key VALUE Send a keypress to the menu
glcdmenu update Update the menu

GPS

Command syntax Short description
nmea get Get latitude and longitude data
nmea satellites Get satellites

H-Bridge

Command syntax Short description
hbridge [action] [enable_l] [enable_r] Set H-Bridge command
hbridge pwm int Set H-Bridge enable line valueeg. speed

I2C (TWI)

Command syntax Short description
bmp085 apress Get absolute pressure in Pa
bmp085 height PRESSNN Get height in cm, pressure at N0 needed
bmp085 pressnn HEIGHT Get pressure at N0, height in cm needed
bmp085 temp Get temperature in 0.1°C
ds1631 convert ADDR VALUE Initiate temperature conversions (0: stop, 1: convert)
ds1631 temp ADDR Read last converted temperature
ee dir List files in I2C EEPROM.
ee rm PATH Remove file PATH.
i2c detect list detected I2C Chips
i2c pca9555 in read word from register address on I2C chip
i2c pca9555 mode VALUE select input or output mode for pins on I2C chip
i2c pca9555 out VALUE write word to register address on I2C chip
i2c rbb ADDR read byte from I2C chip
i2c rbd CHIPADDR REGADDR read byte from register address at I2C chip
i2c rwd CHIPADDR REGADDR read word from register address at I2C chip
i2c wbb ADDR HEXVALUE write byte to I2C chip
i2c wbd CHIPADDR REGADDR HEXVALUE write byte to register address on I2C chip
i2c wwd CHIPADDR REGADDR HEXVALUE write word to register address on I2C chip
lm75 ADDR Get temperature
max7311 getDDRw ADDR Get Direction-Register DDR
max7311 getINw ADDR Get Input-Register IN
max7311 getOUTw ADDR Get Output-Register OUT
max7311 pulse ADDR BIT TIME Toggle Output-BIT for TIME (in ms)
max7311 set ADDR BIT VALUE Set Output-BIT to VALUE (bool)
max7311 setDDRw ADDR VALUE Set Direction-Register DDR (VALUE as hex)
max7311 setOUTw ADDR VALUE Set Output-Register OUT (VALUE as hex)
mcp23017 clear pin ADDR PORT BIT Clear Port BIT for PORT A or B
mcp23017 get iodir ADDR PORT Get I/O Direction Register for PORT A or B
mcp23017 get olat ADDR PORT Get Output Latch Register for PORT A or B
mcp23017 get port ADDR PORT Get Port Register (i.e. Port Pin State) for PORT A or B
mcp23017 getreg ADDR REGADDR Get Register REGADDR
mcp23017 pulse pin ADDR PORT BIT TIME Toggle-Pulse Port BIT for PORT A or B for TIME ms
mcp23017 set iodir ADDR PORT VALUE Set I/O Direction Register for PORT A or B (VALUE as hex)
mcp23017 set olat ADDR PORT VALUE Set Output Latch Register for PORT A or B (VALUE as hex)
mcp23017 set pin ADDR PORT BIT Set Port BIT for PORT A or B
mcp23017 setreg ADDR REGADDR VALUE Set Register REGADDR (VALUE as hex)
mcp23017 toggle pin ADDR PORT BIT Toggle Port BIT for PORT A or B
pca9531 ADDR PERIODPWM1 DUTYPWM1 PERIODPWM2 DUTYPWM2 LED0..3 LED4..7 set PWM1 and PWM2 and LED states
pcf8574x read ADDR CHIP Get bits
pcf8574x set ADDR CHIP HEXVALUE Set bits
tmp175 ADDR Get temperature
tsl2550 lux Show light level by reading adc registers and computing level
tsl2550 mode VALUE Set the TSL2550s operating mode (0: standard range, 1: extended range)
tsl2550 power VALUE Set the TSL2550s power state (0: down, 1:up)
tsl2561 lux DEVNUM Get LUX value
tsl2561 raw DEVNUM Get RAW channel values
tsl2561 setmode DEVNUM TIME GAIN PACKAGE Set device mode

Jabber

Command syntax Short description
jabber_host [HOSTNAME] JABBER hostname
jabber_pass [PASSWORD] JABBER password
jabber_resrc [RESOURCE] JABBER resource
jabber_user [USERNAME] JABBER username

KTY

Command syntax Short description
kty autocalibrate CHANNEL Calibrate to 1000 Ohm precision Resistor.
kty cal get Return the calibration difference to 2k2 Resistor.
kty get [CHANNEL] Get the temperature in xxx.x °C of CHANNEL or if no channel set of all channels.

MotorCurtain commands

Command syntax Short description
curtain VALUE Set value of curtain. 0=closed..7=open. If you use fewer sensors, use the corrent value instead of 7.
curtainlast Return last known position
curtainmax Return maximum position
curtainoff Switch motor off

Named_PIN

Command syntax Short description
pin get NAME Read and display the status of pin NAME.
pin list List all known named-pins.
pin set NAME STATUS Set the status of pin NAME to STATUS.
pin toggle NAME Toggle the status of pin NAME.

PWM

Command syntax Short description
dtmf CHARS send CHARS as DTMF
freq set FREQUENCY DELAY Set frequency for DELAY ms
pwm fade [channel +-diff startvalue] Set fading at channel with startvalue and change each stepp to diff (must be signed 3 digit)
pwm set [channel value] Set channel to value

RFM12

Command syntax Short description
rfm12 reinit Re-initialize the RFM12 FSK module.
rfm12 setbandwidth MODULE BW Set receiver bandwidth of MODULE to BW.
rfm12 setbaud MODULE BAUD Set baudrate of MODULE to BAUD.
rfm12 setdrssi MODULE DRSSI Set the drssi of MODULE to DRSSI.
rfm12 setgain MODULE GAIN Set preamplifier gain of MODULE to GAIN.
rfm12 setmod MOD Set modulation of the RFM12 FSK module to MOD.
rfm12 status MODULE Display internal status of MODULE.

RFM12_ASK

Command syntax Short description
rfm12 ask sense Trigger (Tevion) ASK sensing. Enable ext. filter pin before!
rfm12 external filter [1] Enable ext. filter pin if argument is present (disable otherwise)

RFM12_FS20

Command syntax Short description
fht send housecode addr command data
fs20 receive Receive FS20/FHT sequence and display it.
fs20 send housecode addr command data
fs20 setdebug DEBUG Set debug to DEBUG.

SD-Karte

Command syntax Short description
sd dir List contents of current SD directory.
sd info List information about SD card.
sd mkdir PATH Create directory hierarchy PATH.
sd rm PATH Remove file PATH.

SGC commands

Command syntax Short description
sgc adduc ADDR CH0 CH1 CH2 CH3 CH4 CH5 CH6 CH7 Add user character: address 0..0x1F and 8 bytes character
sgc circle X Y RADIUS Draw circle with parameters and colour specified in sgc_colour
sgc cls Clear screen
sgc colour RED GREEN BLUE Set pen / font colour:red-green-blue 0..0x1F or 2-byte RGB with only two parameters
sgc contrast CONTRAST Set contrast value 0..0x0F
sgc druc ADDR X Y Draw user character saved from sgc_adduc at address 0..0x1F and with colour specified in sgc_colour
sgc font FONT PROPORTIONAL Set font type:0..2 and 0:not proportional 1:proportional
sgc gchar X Y WIDTH HEIGHT CHAR Draw ASCII character in graphics format at specified position and size with colour specified in sgc_colour
sgc getpwr Get Power Status
sgc line X1 Y1 X2 Y2 Draw line between specified points with colour specified in sgc_colour
sgc object UMSB ULSB LMSB LLSB Display object from SD card at specified address
sgc onoff ONOFF Turn display on:1 or off:0
sgc opacity OPACITY Set text opacity 0:transparent 1:opaque
sgc pensize PENSIZE Set pen size 0:solid 1:lines
sgc pixel X Y Draw pixel at specified point with colour specified in sgc_colour
sgc rectangle X1 Y1 X2 Y2 Draw rectangle with specified edges and with colour specified in sgc_colour
sgc repbgc RED GREEN BLUE Replace background colour:red-green-blue 0..0x1F or 2-byte RGB with only two parameters
sgc repcol X_START Y_START X_END Y_END OLD_RED OLD_GREEN OLD_BLUE Replace old colour - red-green-blue 0..0x1F or 2-byte RGB with only two parameters in selected area - with colour specified in sgc_colour
sgc result Get result from last command
sgc scrcp SRC_X SRC_Y DST_X DST_Y WIDTH HEIGHT Copy-Paste selected screen area
sgc script UMSB ULSB LMSB LLSB Run 4DSL script from SD card at specified address
sgc sdicon X Y WIDTH HEIGHT SECTOR0 SECTOR1 SECTOR2 Display icon from SD card at specified position and size stored at specified SD card sector
sgc setbgc RED GREEN BLUE Set background colour:red-green-blue 0..0x1F or 2-byte RGB with only two parameters
sgc setip IPADDR Change response IP address - volatile
sgc setpwr PWR Set Power Status: 1:on 0:off
sgc setsleep AUTO MODE Set Auto Shutdown Sleep 1:on 0:off / Set wakeup mode 0:Serial 1: Joystick
sgc settimeout TIMEOUT Change auto-off idle time - volatile
sgc sleep SLEEP Sleep mode 0:turn off SD 1:wake on serial 2:wake on joystick
sgc stg X Y WIDTH HEIGHT STRING Draw ASCII string in graphics format at specified position and size with colour specified in sgc_colour)
sgc stt COL ROW STRING Draw ASCII string in text format at specified col and row and with colour specified in sgc_colour
sgc tchar COL ROW CHAR Draw ASCII character in text format at specified col and row and with colour specified in sgc_colour
sgc triangle X1 Y1 X2 Y2 X3 Y3 Draw triangle with edges counter-clockwise and with colour specified in sgc_colour
sgc video X Y WIDTH HEIGHT DELAY NUM_FRAMES0 NUM_FRAMES1 SECTOR0 SECTOR1 SECTOR2 Display video / animation from SD card at specified position and size and with specified inter-frame delay and frame number stored at specified SD card sector

SHT

Command syntax Short description
sht humid Return humidity of SHT sensor
sht raw Return raw hex temp (first line) and humidity value (second line) of SHT sensor
sht temp Return temperature of SHT sensor

SMS77

Command syntax Short description
sms77 MESSAGE Send MESSAGE to compiled in sms77 service
sms77_pass [PASSWORD] SMS77 password
sms77_recv [RECEIVER] SMS receiver
sms77_type [TYPE] SMS type
sms77_user [USERNAME] SMS77 username

PWM Servo Control

Command syntax Short description
pwm servo_dec SERVONR Decrement position of servo SERVONR
pwm servo_inc SERVONR Increment position of servo SERVONR
pwm servo_set SERVONR POSITION Set servo with SERVONR to POSITION

Sound/WAV support

Command syntax Short description
pwm stop Stop wav
pwm wav <FILENAME> Play wave file. Use VFS if compiled in. More details at Sound

Stella_Light commands

Command syntax Short description
channel CHANNEL VALUE FUNCTION Get/Set stella channel to value. Second and third parameters are optional. Function: You may use 's' for instant set, 'f' for fade and 'y' for flashy fade.
channels Return stella channel size
fadestep FADESTEP Get/Set stella fade step
stella load Load values from eeprom
stella store Store values in eeprom
tank get get last value
tank param save write tank parameter to EEPROM
tank param set PARAM VALUE set tank parameter
tank param show show tanklevel parameters
tank start start measure
tank zero probe sensor zero offset

USB

Command syntax Short description
keyboard MESSAGE Send MESSAGE as HID keyboard
mouse BUTTON DELTAX DELTAY Send data as HID mouse

ZACwire

Command syntax Short description
zac 306 PORT BIT Return temperature of TSic 306 at BIT of PORT
zac 506 PORT BIT Return temperature of TSic 506 at BIT of PORT
zac raw PORT BIT Return raw hex temperature value of zacwire at BIT of PORT

lome6

Command syntax Short description
lome6 get_t TYPE get temperature command
lome6 power TYPE press power command
lome6 reset press reset command
lome6 set_t TYPE TEMPERATURE set temperature command
lome6 state get state command
lome6 uptime UPTIME set/get uptime command

Miscelleanous

Command syntax Short description
alias list List all available aliases
artnet test artnet test
cw send MESSAGE Send MESSAGE in Morce Code
d ADDR Dump the memory at ADDR (16 bytes).
eeprom reinit Force reinitialization of the EEPROM config area
ems stats Report statistic counters
free Display free space.
help List which commands are available.
ht MESSAGE Send MESSAGE to compiled in httplog service
ipstats Display IP statistics.
mb recv Receive data from modbus
moodlight CHANNEL ONOFF Set CHANNEL moodlight on=1 or off=0. If no channel is given return on if channel CHANNEL is moodlighted
motd [MESSAGE] Save MESSAGE as new message of the day, otherwise just show current message
msr1 get Get data
mysql query QUERY Send specified MySQL query to the configured server
ns update net statistic for public anouncment of currently running ethersex
pam USER PASSWORD Use pam for user and password
push NUMBER Push button identified by NUMBER
pwm melody [NUMBER] Play melody
sanyoz700 CMD Send command to projector
sll get Request the logged data
sram memtest Perform a memory test
srf05 Read SRF05 measurement
to1 get Request data from sensor
tw MESSAGE Send MESSAGE to compiled in twitter service
upnp send Manually send UPnP broadcast packet
usart baud BAUD Set the USART baudrate to BAUD.
version Display the version number.
weather Get eltako weather data
wol MAC Send WAKE-ON-LAN command to MAC
yport stats Report statistic counters
zbus stats Report statistic counters
Personal tools
Namespaces

Variants
Actions
Navigation
Tools