Skip to content

Latest commit

 

History

History
89 lines (68 loc) · 4.15 KB

protocol.md

File metadata and controls

89 lines (68 loc) · 4.15 KB
Raw

eQ3/ELV MAX! Cube Protocol

Disclaimer

The main info about the eQ3 Cube Protocol comes from these sources:

But i have seen that some of the information that is provided there is not correct (at least for my cube which runs firmware verison 1.1.3). For that reason i've started to describe the protocol here, so that everybody can contibute and profit.

Feel free to send me pull request or open an issue to help me getting this right!

All information in this file are valid (or at least work for me) with cube version 1.1.3.

Connecting to the cube

You can connect to the cube by establishing a TCP connection with the cube's IP address on port 62910. To do so you can use telnet for a first test:

telnet 192.168.178.22 62910

The cube will immediately reply with a lot of information. The further sections will describe what this data means.

Message structure

A message always (as far as i know) begins with a single character followed by a colon, H: for example. Furthermore a message is always ended by a CR+LF \r\n. In between these two marks is the content of the message.

Message types

There are a lot of message types. I have not seen a lot of them yet, but the list is out of the decompiled source code so it seems to be valid.

Incoming messages

INCOMING HELLO:                       "H:"
INCOMING NTP SERVER:                  "F:"
INCOMING DEVICE LIST:                 "L:"
INCOMING CONFIGURATION:               "C:"
INCOMING METADATA:                    "M:"
INCOMING NEW DEVICE:                  "N:"
INCOMING ACKNOWLEDGE:                 "A:"
INCOMING ENCRYPTION:                  "E:"
INCOMING DECRYPTION:                  "D:"
INCOMING SET CREDENTIALS:             "b:"
INCOMING GET CREDENTIALS:             "g:"
INCOMING SET REMOTEACCESS:            "j:"
INCOMING SET USER DATA:               "p:"
INCOMING GET USER DATA:               "o:"
INCOMING CHECK PRODUCT ACTIVATION:    "v:"
INCOMING ACTIVATE PRODUCT:            "w:"
INCOMING SEND DEVICE CMD:             "S:"

Outgoing messages

OUTGOING URL:                         "u:"
OUTGOING INTERVAL:                    "i:"
OUTGOING SEND:                        "s:"
OUTGOING METADATA:                    "m:"
OUTGOING INCLUSION MODE:              "n:"
OUTGOING CANCEL INCLUSION MODE:       "x:"
OUTGOING MORE DATA:                   "g:"
OUTGOING QUIT:                        "q:"
OUTGOING ENCRYPTION:                  "e:"
OUTGOING DECRYPTION:                  "d:"
OUTGOING SET CREDENTIALS:             "B:"
OUTGOING GET CREDENTIALS:             "G:"
OUTGOING SET REMOTEACCESS:            "J:"
OUTGOING SET USER DATA:               "P:"
OUTGOING GET USER DATA:               "O:"
OUTGOING CHECK PRODUCT ACTIVATION:    "V:"
OUTGOING ACTIVATE PRODUCT:            "W:"
OUTGOING RESET:                       "a:"
OUTGOING RESET ERROR:                 "r:"
OUTGOING DELETE DEVICES:              "t:"
OUTGOING SET PUSHBUTTON CONFIG:       "w:"
OUTGOING GET DEVICE LIST:             "l:"
OUTGOING GET CONFIGURATION:           "c:"
OUTGOING TIME CONFIG:                 "v:"
OUTGOING NTP SERVER:                  "f:"
OUTGOING SEND WAKEUP:                 "z:"

Duty cycle

The MAX! components communicate with eachother using the 868MHz frequency band. The use of his frequency band is regulated in various countries. This forces the components to respect a 1% rule on a per hour basis. This means that every MAX! device can send up to 1% of the time per hour, meaning 36 seconds per hour. If they exceed the 36 seconds, they must stop sending for the rest of this hour.

The components keep track of used time in the duty_cycle field. The value is in %. So a duty_cycle value of 76 means that 76% of the hourly allowance has been used. When this value reaches 99% the component will stop sending messages. Every hour the value gets reset.