Ecmd Reference: Unterschied zwischen den Versionen

Aus Ethersex_Wiki
Wechseln zu: Navigation, Suche
(Importing text file)
(Importing text file)
Zeile 17: Zeile 17:
 
|-
 
|-
 
| whm  
 
| whm  
|  Display the uptime.
+
|  Display ethersex uptime.
|-
 
|}
 
== Cron commands (dynamic variant) ==
 
{| border='1'
 
| ''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 ==
 
{| border='1'
 
| ''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
 
 
|-
 
|-
 
|}
 
|}
Zeile 60: Zeile 30:
 
| nslookup  HOSTNAME
 
| nslookup  HOSTNAME
 
|  Do DNS lookup for HOSTNAME (call twice).
 
|  Do DNS lookup for HOSTNAME (call twice).
|-
 
|}
 
== Dallas 1-wire ==
 
{| border='1'
 
| ''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 ==
 
{| border='1'
 
| ''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 Scripting ==
 
{| border='1'
 
| ''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
 
 
|-
 
|-
 
|}
 
|}
Zeile 161: Zeile 47:
 
|-
 
|-
 
|}
 
|}
== HD44780 LCD Display ==
+
== HD44780 [[LCD]] Display ==
 
{| border='1'
 
{| border='1'
 
| ''Command syntax''
 
| ''Command syntax''
Zeile 206: Zeile 92:
 
|-
 
|-
 
|}
 
|}
== KTY ==
+
== Infrarat Sender/Empfänger ([[IR-TRX]]) ==
 
{| border='1'
 
{| border='1'
 
| ''Command syntax''
 
| ''Command syntax''
 
| ''Short description''
 
| ''Short description''
 
|-
 
|-
| kty autocalibrate  CHANNEL
+
| ir receive
| Calibrate to 1000 Ohm precision Resistor.
+
| receive an IR command
 
|-
 
|-
| kty cal get
+
| ir send  DEVICE COMMAND
Return the calibration difference to 2k2 Resistor.
+
send COMMAND to DEVICE
|-
 
| kty get  [CHANNEL]
 
|  Get the temperature in xxx.x °C of CHANNEL or if no channel set of all channels.
 
 
|-
 
|-
 
|}
 
|}
Zeile 250: Zeile 133:
 
|  Display/Set the IP address of the NTP server to use to IPADDR.
 
|  Display/Set the IP address of the NTP server to use to IPADDR.
 
|-
 
|-
|}
+
| wol  IP
== Named Pins ==
+
| Send WAKE-ON-LAN command to IP
{| border='1'
 
| ''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.
 
 
|-
 
|-
 
|}
 
|}
Zeile 283: Zeile 154:
 
| Display/Set the network mask.
 
| Display/Set the network mask.
 
|-
 
|-
|}
+
| push  NUMBER
== PWM Servo Control ==
+
| Push button identified by NUMBER
{| border='1'
 
| ''Command syntax''
 
| ''Short description''
 
|-
 
| pwm servo_dec
 
|  Dec servo position
 
|-
 
| pwm servo_inc
 
|  Inc servo position
 
|-
 
| pwm servo_set
 
| Set servo position
 
 
|-
 
|-
 
|}
 
|}
Zeile 321: Zeile 180:
 
| io set port  NUM HEXVALUE [MASK]
 
| io set port  NUM HEXVALUE [MASK]
 
|  Set the PORT NUM to VALUE (possibly using the provided MASK).
 
|  Set the PORT NUM to VALUE (possibly using the provided MASK).
|-
 
|}
 
== RFM12 ==
 
{| border='1'
 
| ''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.
 
 
|-
 
|-
 
|}
 
|}
Zeile 380: Zeile 215:
 
|-
 
|-
 
|}
 
|}
== SD/MMC Card Reader ==
+
== Sound/Melody support ==
 +
{| border='1'
 +
| ''Command syntax''
 +
| ''Short description''
 +
|-
 +
| pwm melody 
 +
|  Play melody
 +
|-
 +
| pwm stop 
 +
|  Stop wav
 +
|-
 +
| pwm wav 
 +
|  Play wav
 +
|-
 +
|}
 +
== [[CRON-Dienst]] ==
 +
{| border='1'
 +
| ''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
 +
|-
 +
| pam  USER PASSWORD
 +
|  Use pam for user and password
 +
|-
 +
|}
 +
== [[DMX]] ==
 +
{| border='1'
 +
| ''Command syntax''
 +
| ''Short description''
 +
|-
 +
| dmx fade
 +
| Fade DMX
 +
|-
 +
| dmx set6chan  A B C D E F G
 +
| Set DMX values
 +
|-
 +
| mb recv 
 +
| Receive data from modbus
 +
|-
 +
|}
 +
== [[Dallas_1-wire_Bus]] ==
 +
{| border='1'
 +
| ''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]] ==
 +
{| border='1'
 +
| ''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_camera|DC3840 mobil camera support]] ==
 +
{| border='1'
 +
| ''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
 +
|-
 +
|}
 +
== [[ECMDScript]] ==
 
{| border='1'
 
{| border='1'
 
| ''Command syntax''
 
| ''Command syntax''
 
| ''Short description''
 
| ''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
 +
|-
 +
|}
 +
== [[KTY]] ==
 +
{| border='1'
 +
| ''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.
 +
|-
 +
|}
 +
== [[Named_PIN]] ==
 +
{| border='1'
 +
| ''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.
 +
|-
 +
|}
 +
== [[Netstat]] ==
 +
{| border='1'
 +
| ''Command syntax''
 +
| ''Short description''
 +
|-
 +
| msr1 get
 +
| Get data
 +
|-
 +
| nmea get
 +
| Get latitude and longitude data
 +
|-
 +
| nmea satellites
 +
| Get satellites
 +
|-
 +
| ns
 +
| update net statistic for public anouncment of currently running ethersex
 +
|-
 +
| to1 get
 +
| Request data from sensor
 +
|-
 +
|}
 +
== [[RFM12]] ==
 +
{| border='1'
 +
| ''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.
 +
|-
 +
|}
 +
== [[SD/MMC-Card-Reader]] ==
 +
{| border='1'
 +
| ''Command syntax''
 +
| ''Short description''
 +
|-
 +
| artnet test
 +
| artnet test
 
|-
 
|-
 
| sd dir  
 
| sd dir  
Zeile 392: Zeile 455:
 
|-
 
|-
 
|}
 
|}
== Sound/Melody support ==
+
== [[Servo_Ansteuerung|PWM Servo Control]] ==
 
{| border='1'
 
{| border='1'
 
| ''Command syntax''
 
| ''Command syntax''
 
| ''Short description''
 
| ''Short description''
 
|-
 
|-
| pwm melody 
+
| pwm servo_dec SERVONR
Play melody
+
Decrement position of servo SERVONR
 
|-
 
|-
| pwm stop 
+
| pwm servo_inc SERVONR
Stop wav
+
Increment position of servo SERVONR
 
|-
 
|-
| pwm wav 
+
| pwm servo_set SERVONR POSITION
Play wav
+
Set servo with SERVONR to POSITION
 
|-
 
|-
 
|}
 
|}
== StellaLight commands ==
+
== [[Stella_Light]] commands ==
 
{| border='1'
 
{| border='1'
 
| ''Command syntax''
 
| ''Command syntax''
Zeile 459: Zeile 522:
 
| mysql query  QUERY
 
| mysql query  QUERY
 
|  Send specified MySQL query to the configured server
 
|  Send specified MySQL query to the configured server
|-
 
| ns
 
| Net Statistic - Public anouncment of running ethersex
 
 
|-
 
|-
 
| tlc5620  `[CHANNEL] [VALUE]
 
| tlc5620  `[CHANNEL] [VALUE]
 
|  Set Output to value (Value: 0-0xff)'
 
|  Set Output to value (Value: 0-0xff)'
 +
|-
 +
| tw  MESSAGE
 +
| Send MESSAGE to compiled in twitter service
 
|-
 
|-
 
| upnp send  
 
| upnp send  
| Send UPnP broadcast packet
+
| Manually send UPnP broadcast packet
 
|-
 
|-
 
| usart baud  BAUD
 
| usart baud  BAUD

Version vom 27. September 2009, 13:42 Uhr

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!


Clock

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

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

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

Infrarat Sender/Empfänger (IR-TRX)

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

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

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.
wol IP Send WAKE-ON-LAN command to IP

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.
push NUMBER Push button identified by NUMBER

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

Sound/Melody support

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

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_list Show all cron entries
cron_rm POSITION Remove one cron entry
pam USER PASSWORD Use pam for user and password

DMX

Command syntax Short description
dmx fade Fade DMX
dmx set6chan A B C D E F G Set DMX values
mb recv Receive data from modbus

Dallas_1-wire_Bus

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.

DC3840 mobil camera 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

ECMDScript

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

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.

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.

Netstat

Command syntax Short description
msr1 get Get data
nmea get Get latitude and longitude data
nmea satellites Get satellites
ns update net statistic for public anouncment of currently running ethersex
to1 get Request data from sensor

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.

SD/MMC-Card-Reader

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

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

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

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.
fuse Display the fuse settings.
help List which commands are available.
ipstats Display IP statistics.
mysql query QUERY Send specified MySQL query to the configured server
tlc5620 `[CHANNEL] [VALUE] Set Output to value (Value: 0-0xff)'
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.