Ecmd Reference

This page is automatically generated from ecmd_defs.m4 and wiki.m4 which are part of the Ethersex source code repository. Do not edit this page but send patches for those files!

Analog/Digital Conversion (ADC)

Command syntax	Short description
adc get [CHANNEL]	Get the ADC value in hex of CHANNEL or if no channel set of all channels.

Clock

Command syntax	Short description
date	Display the current date.
time	Display the current time in seconds since January 1st 1970.
whm	Display the uptime.

Cron commands (dynamic variant)

Command syntax	Short description
cron_add MIN HOUR DAY MONTH DOW ECMD	Add ECMD to cron to be executed at given time
cron_list	Show all cron entries
cron_rm POSITION	Remove one cron entry

DC3840 Handycam support

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

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).

Dallas 1-wire

Command syntax	Short description
1w convert [DEVICE]	Trigger temperature conversion of either DEVICE or all connected devices
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

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.

ECMD Aliases

Command syntax	Short description
alias list	List all available aliases

ECMD Scripting

Command syntax	Short description
call FILENAME	Start script named FILENAME
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

EEPROM

Command syntax	Short description
eeprom reinit	Force reinitialization of the EEPROM config area

FS20

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

HD44780 LCD Display

Command syntax	Short description
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

I2C (TWI)

Command syntax	Short description
i2c detect	list detected I2C Chips
lm75 ADDR	Get temperature
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

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.

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

MySQL

Command syntax	Short description
mysql query QUERY	Send specified MySQL query to the configured server

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.

Named Pins

Command syntax	Short description
pin get NAME	Read and display the status of pin NAME.
pin set NAME STATUS	Set the status of pin NAME to STATUS.
pin toggle NAME	Toggle the status of pin NAME.

Network IP Statistics

Command syntax	Short description
ipstats	Display IP statistics.

Network Statistics

Command syntax	Short description
ns	Net Statistic - Public anouncment of running ethersex

Network configuration

Command syntax	Short description
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.

PWM Servo Control

Command syntax	Short description
pwm servo_init	Initialise servo
pwm servo_set	Set servo position

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).

RFM12

Command syntax	Short description
rfm12 setbandwidth BW	Set RX bandwidth to BW.
rfm12 setbaud BAUD	Set baudrate to BAUD.
rfm12 setdrssi DRSSI	Set the drssi to DRSSI.
rfm12 setgain GAIN	Set preamplifier gain to GAIN.
rfm12 setmod MOD	Set modulation to MOD.
rfm12 status	Display internal status.

RFM12 ASK

Command syntax	Short description
rfm12 2272	housecodeCommand delay cnt
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 tevion	housecode command delay cnt

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.

SD/MMC Card Reader

Command syntax	Short description
sd dir	List contents of current SD directory.
sd mkdir PATH	Create directory hierarchy PATH.

Sound/Melody support

Command syntax	Short description
pwm melody	Play melody
pwm stop	Stop wav
pwm wav	Play wav

Stella commands

Command syntax	Short description
channel get CHANNEL	Get stella channel value
channel set CHANNEL VALUE FUNCTION	Set stella channel to value. The third parameter is optional. You may use 's' for instant set, 'f' for fade and 'y' for flashy fade.
channels	Return stella channel size
moodlight get CHANNEL	Return on if channel CHANNEL is moodlighted
moodlight set CHANNEL ONOFF	Set CHANNEL moodlight on=1 or off=0
stella cron CHANNEL VALUE MINUTE HOUR DAY MONTH DAYOFWEEK	Add a cronjob for stella to set the CHANNEL to VALUE. You may use fade channel constants.
stella fadestep get	Get stella fade step
stella fadestep set FADESTEP	Set stella fade step
stella load	Load values from eeprom
stella store	Store values in eeprom

UPnP

Command syntax	Short description
upnp send	Send UPnP broadcast packet

Miscelleanous

Command syntax	Short description
adc get [CHANNEL]	Get the ADC value in hex of CHANNEL or if no channel set of all channels.
alias list	List all available aliases
d ADDR	Dump the memory at ADDR (16 bytes).
eeprom reinit	Force reinitialization of the EEPROM config area
free	Display free space.
help	List which commands are available.
ipstats	Display IP statistics.
mysql query QUERY	Send specified MySQL query to the configured server
ns	Net Statistic - Public anouncment of running ethersex
upnp send	Send UPnP broadcast packet
usart baud BAUD	Set the USART baudrate to BAUD.
version	Display the version number.