LightwaveRF

Command set

DISCLAIMER
This document outlines the command protocols currently in use in the LightwaveRF system.
JSJS Designs do not offer any guarantee that any part of this protocol will not change
WITHOUT NOTICE at any time, or that any part of this protocol will continue to work with
any of our products. If you intend to rely on these commands as part of a commercial
system please contact us directly to discuss a technical partnership agreement.

V1.3.2 August 2012

This document is not to be distributed or reproduced without the written permission of :

JSJS Designs plc
Faraday Wharf
Birmingham B7 4BB
(t) 0121 250 3625
(e) support@jsjsdesigns.com


Basic protocol.
Protocol is human readable ASCII packets of the form below. User sends commands (timing is not critical) via UDP broadcast
on port 9760 across the local network , however a command will timeout if there is more than two seconds between
characters. Replies will be sent to the sending IP on port 9761.
Example command structure: !R1D16F1 <cr>is Room1 Device 16 Function ON.
<start character>R<RoomNo>D<DeviceNo>F<FunctionType>P<Parameter><cr>
Where
<Start Character>=

! (Send command) or
? (Query command) or
@ (systems parameter)

<RoomNo>= Lightwave Room valid 1 -> 16 in ascii .

<DeviceNo> = Device No within room 1->16 in ascii (Optional).
<Function type>is single lower cased Ascii letter Commands
0- 1- >- <- a- c- d- e- f- g- h- i- k- l- m- n- s- r- q- t- u- xOff (Thats a zero) On (thats a One) Dim Up Dim Down
<Parameter>is a optional Maximum 4 digit Integer value / 16-character text. Examples : P16 or P1234
<cr> carriage return IMPORTANT!!

JSJS Designs plc LightwaveRF Local Commands V1.3.2 Not to be distributed without permission

Page


Command Package
The full command package sent is :

<transaction number>,<Command><cr>
For example :
372,!R1D1F1<cr>
will turn on device 1 in room 1.

373,!FeP"HeatTest"=!R4D3F1,00:00:03,!R8DhF1,00:00:03,!R4D3F0,00:00:03,!R8DhF0,00:00:03,!R4D3F1,
00:00:03,!R8DhF1,00:00:03,!R4D3F0,00:00: 03,!R8DhF0,00:00:03<cr>
will define a sequence called Heat Test which will fire off 8 different commands each at 3 second intervals.

The wifilink will send you back a reply looking like :

372,OK
If you dont include the transaction number the reply will be sent with transaction 000. Transaction numbers should increment after
every command, should always be 3 digits and should start at different numbers for each user sending commands.

JSJS Designs plc LightwaveRF Local Commands V1.3.2 Not to be distributed without permission

Page

Example Interaction

Normal command with

transaction ID, reply received
OK.
Command with screen
description.
No transaction ID sent to wifilink
replies to ID 0.
Badly formed command no
reply so assume failure.

JSJS Designs plc LightwaveRF Local Commands V1.3.2 Not to be distributed without permission

Page


Function list
Command

Operator Example

BASIC ON/OFF/DIM
Turn On Room1 Device 1.
Turn Off Room1 Device 2
All off in Room 1
Set to last recorded dim level

F
Fa
Fo

!R1D1F1
!R1D2F0
!R1Fa
!R1D1Fo (that letter o not zero)

Dim Device (Dim levels 1-32)

FdP

!R1D1FdP32

FsP
FmP

!R1FsP3
!R3FmP1

Fl
Fk
Fu

!R1D1Fl
!R1D1Fk
!R1D1Fu

MOODS
Save current settings as Room 1 Mood 3
Recall Room 3 Mood 1

LOCK
Room 1 Device 1 Manual lock.
Full Lock (Manual and Radio).
Unlock

JSJS Designs plc LightwaveRF Local Commands V1.3.2 Not to be distributed without permission

Page

TIMERS
32 timers and sequences maximum.
Each timer can have a start Date/Time, End Date., Day Matrix and a SINGLE command.
OFF and ON timers are separate and need two timers. Combine them as a sequence to put on one timer.
Names - alphanumeric - maximum 16 characters. Enclose in .
Sequences and timers live in the same space so should not have the same name.
Timers can fire sequences or individual commands
Command
Operator
Set timer
FiP
Repeat Day of week
FiP
rd
Repeat 3 of month
FiP
Repeat Last day of month in winter
FiP
Repeat at dusk + 1 hour every 5 days until 2011 FiP
Repeat every year 5th April
FiP
Remember to be careful with times around midnight.
Delete timer
FxP

Example
!FiPLight on Later=!FqP!R1D1F1,T7:45
!FiPWeekday Wake=!FqPWakey,T7:45,Wmtwtfxx
!FiPDinner time=!FqPAlarm,T17:45,S03/00/00,Mjfmamjjasond
!FiPClose Up time=!FqPAlarm,T22:45,S99/00/00,Mjfxxxxxxxxxd
!FiPWeekday Wake=!FqPWakey,T99:02,S05/00/00
!FiPTax Time=!FqPAllLightsOn,T7:45,D05/04/00
!FxP"2011121216574"|Deleting Timer

Format:
!FiP"<name>"=<command>,T<time>,S<Start date>,E<End date>,W<Weekdays>,M<Month list>
e.g. !FiP"T201001271834"=!FqP"SampleSequence",T18:30,S25/01/10,E31/12/19,Wmtwxxxs,Mjfmamjjasond

Special Time and Date signifiers

Certain things like the last day of the week or dawn cannot be transmitted by the normal time or date structures:
Special Times (hh:mm)
96:xx
97:xx
98:xx
99:xx
Dawn-xx * 30 minutes. Dawn+xx * 30 minutes Dusk-xx * 30 minutes. Dusk+xx * 30 minutes.
Special Dates (dd/mm/yy)
99/xx/xx = Last Day of Month. (e.g. 99/00/00)
(use this rather than a date as if you use 31/01/00 then because 31 February does not exist, timer will not fire).
JSJS Designs plc LightwaveRF Local Commands V1.3.2 Not to be distributed without permission

Page

SEQUENCES
Sequences with the same name will overwrite the existing sequence.
Maximum sequence string 256 characters. 32 sequences and timers in total allowed, 10 maximum items in sequence.
Recalling the same sequence before the end of a sequence of the same name will cancel the running sequence.
Command
Store sequence
Start sequence
Cancel running sequence
Delete sequence
Cancel ALL Sequences and timers
Delete ALL Sequences and timers

Operator
!FeP
!FqP
!FcP
!FxP

Example
!FePHello=,!R1D1F1,00:00:15 ,!R1D1F0
!FqPHello|Start Sequence|Hello
!FcP"Sample Sequence"|Cancel Sequence|Sample Sequence
!FxP"Sample Sequence"|Deleting Sequence
!FcP"*"
!FxP"*"

Format:
!FeP<sequence name>=<command>,<delay> ,( <command>,<delay>)

*up to xx times

JSJS Designs plc LightwaveRF Local Commands V1.3.2 Not to be distributed without permission

Page

Open / Close Devices

Command
Open
Stop
Close

Operator
F)
F^
F(

Example
!R1D1F)
!R1D1F^
!R1D1F(

Other Commands
Query software version number

?v

@?v

Eco Meter commands

To query eco meter

(response is xxx,?V="T1.90")

124,@?W<cr>
Response is: 124, ?W=290,2930,5610,14730;?V=2.20;
Readings in watts, current, maximum today, total today, total yesterday
and software version number (2.20)

JSJS Designs plc LightwaveRF Local Commands V1.3.2 Not to be distributed without permission

Page

Timezone

Command
To set timezone

Operator
!FzP(+-)nn

Example

!FzP-11 GMT - 11 hours

!FzP1 gmt + 1

Default = GMT

Latitude and Longtitude.

Geo-pos defaults to Birmingham, UK
Force to 3 digits and 2 decimals.
Set location to Birmingham, UK

!FpP"+-ooo.oo,+-lll.ll"
!FpP-005.20,035.56

- Birmingham

Format :
!FpP"+-ooo.oo,+-lll.ll"
!FpP"+-< longtitude decimal format >,+-< latitude decimal format >"
NB:Force to 3 digits and 2 decimals.

JSJS Designs plc LightwaveRF Local Commands V1.3.2 Not to be distributed without permission

Page