Lamp-Da 0.1
A compact lantern project
Loading...
Searching...
No Matches
elk_decoder.h
Go to the documentation of this file.
1
5#pragma once
6
7#include <array>
8#include <cstdint>
9
10namespace lampda {
11namespace common {
13namespace elk {
14
15enum class Type : uint8_t
16{
17 INVALID = 0,
18 ONOFF,
23 MIC_ONOFF,
24 MIC_MODE,
26 SET_TIME,
27 TIMING,
28};
29
30struct Package
31{
32 Type type = Type::INVALID;
33
34 uint8_t dataSize = 0;
35 std::array<uint8_t, 5> data;
36};
37
41inline bool decode_ELK_message(const uint8_t* msg, uint16_t len, Package& package)
42{
43 package.type = Type::INVALID;
44 package.dataSize = 0;
45
46 // basic check: ELK messages are 9 char long
47 if (len != 9)
48 return false;
49 // Must start with 7E and end with EF
50 if (msg[0] != 0x7E || msg[8] != 0xEF)
51 return false;
52
53 switch (msg[2])
54 {
55 case 0x01: // BRIGHTNESS [0-100]
56 {
57 if (msg[3] > 100)
58 return false;
59
60 package.type = Type::BRIGHTNESS;
61 package.data[0] = msg[3]; // [0; 100]
62 package.dataSize = 1;
63 return true;
64 }
65 case 0x02: // PATTERN_SPEED [0-100]
66 {
67 if (msg[3] > 100)
68 return false;
69
70 package.type = Type::PATTERN_SPEED;
71 package.data[0] = msg[3]; // [0; 100]
72 package.dataSize = 1;
73 return true;
74 }
75 case 0x03:
76 {
77 // PATTERN_SELECT [0-28]
78 if (msg[4] == 0x03)
79 {
80 const uint8_t patternId = (msg[3] >= 128) ? (msg[3] - 128) : msg[3];
81 if (patternId > 28)
82 return false;
83
84 package.type = Type::PATTERN_SELECT;
85 package.data[0] = patternId; // [0; 28]
86 package.dataSize = 1;
87 return true;
88 }
89 // MIC_MODE: 0 = Classic, 1 = Soft, 2 = Dynamic, 3 = Disco.
90 else if (msg[4] == 0x04)
91 {
92 const uint8_t micMode = (msg[3] >= 128) ? (msg[3] - 128) : msg[3];
93 if (micMode > 3)
94 return false;
95
96 package.type = Type::MIC_MODE;
97 package.data[0] = micMode; // [0; 3]
98 package.dataSize = 1;
99 return true;
100 }
101 break;
102 }
103 case 0x04: // ONOFF
104 {
105 // [0x00; 0x01] for legacy, [0x00, 0xF0] for new versions
106 if (msg[3] != 0x00 and msg[3] != 0x01 and msg[3] != 0xF0)
107 return false;
108
109 package.type = Type::ONOFF;
110 package.data[0] = msg[3] != 0x00;
111 package.dataSize = 1;
112 return true;
113 }
114 case 0x05: // COLOR_SELECT
115 {
116 if (msg[3] == 0x03)
117 {
118 package.type = Type::COLOR_SELECT;
119 package.data[0] = msg[4];
120 package.data[1] = msg[5];
121 package.data[2] = msg[6];
122 package.dataSize = 3;
123 return true;
124 }
125 break;
126 }
127 case 0x06: // MIC_SENSITIVITY [0-100]
128 {
129 if (msg[3] > 100)
130 return false;
131
132 package.type = Type::MIC_SENSITIVITY;
133 package.data[0] = msg[3]; // [0; 100]
134 package.dataSize = 1;
135 return true;
136 }
137 case 0x07: // MIC_ONOFF
138 {
139 if (msg[3] > 0x01)
140 return false;
141
142 package.type = Type::MIC_ONOFF;
143 package.data[0] = msg[3];
144 package.dataSize = 1;
145 return true;
146 }
147
148 case 0x82: // TIMING
149 {
150 package.type = Type::TIMING;
151 package.data[0] = msg[3];
152 package.data[1] = msg[4];
153 package.data[2] = msg[5];
154 package.data[3] = msg[6];
155 package.data[4] = msg[7];
156 package.dataSize = 5;
157 return true;
158 }
159 case 0x83: // SET_TIME
160 {
161 package.type = Type::SET_TIME;
162 package.data[0] = msg[3];
163 package.data[1] = msg[4];
164 package.data[2] = msg[5];
165 package.data[3] = msg[6];
166 package.dataSize = 4;
167 return true;
168 }
169 default:
170 break;
171 }
172 return false;
173}
174
175} // namespace elk
176} // namespace common
177} // namespace lampda
bool decode_ELK_message(const uint8_t *msg, uint16_t len, Package &package)
Decode a given message, assuming it it a ELK control message.
Definition: elk_decoder.h:41
Type
Definition: elk_decoder.h:16
@ PATTERN_SPEED
set the current pattern speed
@ PATTERN_SELECT
select a display pattern in a list
@ BRIGHTNESS
set a brightness
@ COLOR_SELECT
set output as a target color
@ ONOFF
turn output onand off
@ MIC_SENSITIVITY
set microphone sensitivity
@ SET_TIME
set the system time to a set time
@ MIC_ONOFF
turn on/off the microphone
@ TIMING
set a desired on/off time
@ MIC_MODE
set the pattern changes type with the microphone
Program scope.
Definition: control_fixed_modes.hpp:14
Definition: elk_decoder.h:31