Coco Api
Coco Api
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.
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.
<start character>R<RoomNo>D<DeviceNo>F<FunctionType>P<Parameter><cr>
Where
<Start Character>= ! (Send command) or
? (Query command) or
@ (systems parameter)
<Parameter>is a optional Maximum 4 digit Integer value / 16-character text. Examples : P16 or P1234
Command*Package*
<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.
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.
Function*list*
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)
MOODS*
Recall Room 3 Mood 1 FmP !R3FmP1
LOCK*
Room 1 Device 1 Manual lock. Fk !R1D1Fk
Full Lock (Manual and Radio). Fl !R1D1Fl
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.
Format:
!FeP”<sequence name>”=<command>,<delay> ,( <command>,<delay>) *up to xx times
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)
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 >"