0% found this document useful (0 votes)
73 views

Coco Api

coco api

Uploaded by

mark meerdam
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
73 views

Coco Api

coco api

Uploaded by

mark meerdam
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 9

/ h / h L̋ Бǵſ̋ ĀБűĢ̋ Ā̂ */ Ģ̊ ̊ Ā̋ ĠɐǵБ!

DISCLAIMER*

This document outlines the command protocols currently in use in the ICS-1000.

COCO International does 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 – February 2012

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

COCO International B.V.


Laan van Barcelona 600
3317 DD Dordrecht
078-7111260
info@coco-technology.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- x-
Off (That’s a zero) On (that’s 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!!

© COCO International Not to be distributed without permission Page 2


*

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 don’t 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.

© COCO International Not to be distributed without permission Page 3


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.

© COCO International Not to be distributed without permission Page 4


*

Function*list*

Command' Operator' Example'

BASIC*ON/OFF/DIM*
Turn On Room1 Device 1. F !R1D1F1
Turn Off Room1 Device 2 !R1D2F0
All off in Room 1 Fa !R1Fa
Set to last recorded dim level Fo !R1D1Fo (that letter o not zero)

Dim Device (Dim levels 1-32) FdP !R1D1FdP32

MOODS*
Recall Room 3 Mood 1 FmP !R3FmP1

LOCK*
Room 1 Device 1 Manual lock. Fk !R1D1Fk
Full Lock (Manual and Radio). Fl !R1D1Fl

© COCO International Not to be distributed without permission Page 5


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 Example


Set timer FiP !FiP”Light on Later”=!FqP”!R1D1F1”,T7:45
Repeat Day of week FiP !FiP”Weekday Wake”=!FqP”Wakey”,T7:45,Wmtwtfxx
rd
Repeat 3 of month FiP !FiP”Dinner time”=!FqP”Alarm”,T17:45,S03/00/00,Mjfmamjjasond
Repeat Last day of month in winter FiP !FiP”Close Up time”=!FqP”Alarm”,T22:45,S99/00/00,Mjfxxxxxxxxxd
Repeat at dusk + 1 hour every 5 days until 2011 FiP !FiP”Weekday Wake”=!FqP”Wakey”,T99:02,S05/00/00
Repeat every year 5th April FiP !FiP”Tax Time”=!FqP”AllLightsOn”,T7:45,D05/04/00
• Remember to be careful with times around midnight.
Delete timer FxP !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/13/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).
© COCO International Not to be distributed without permission Page 6
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 Operator Example


Store sequence !FeP !FeP”Hello”=,!R1D1F1,00:00:15 ,!R1D1F0
Start sequence !FqP !FqP”Hello”|Start Sequence|Hello
Cancel running sequence !FcP !FcP"Sample Sequence"|Cancel Sequence|Sample Sequence
Delete sequence !FxP !FxP"Sample Sequence"|Deleting Sequence

Cancel ALL Sequences and timers !FcP"*"


Delete ALL Sequences and timers !FxP"*"

Format:
!FeP”<sequence name>”=<command>,<delay> ,( <command>,<delay>) *up to xx times

© COCO International Not to be distributed without permission Page 7


Open*/*Close*Devices*

Command Operator Example


Open F) !R1D1F)
Stop F^ !R1D1F^
Close F( !R1D1F(

Other*Commands*
Query software version number ?v @?v (response is xxx,?V="T1.90")

Eco*Meter*commands*
To query eco meter 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)

© COCO International Not to be distributed without permission Page 8


Timezone**

Command Operator Example


To set timezone !FzP(+-)nn !FzP-11 GMT - 11 hours
!FzP1 gmt + 1

Default = GMT

Latitude*and*Longtitude.*
! Geo-pos defaults to Birmingham, UK !FpP"+-ooo.oo,+-lll.ll"
! Force to 3 digits and 2 decimals.
Set location to Birmingham, UK !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.

© COCO International Not to be distributed without permission Page 9

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy