| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366 | 1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
3x
3x
3x
3x
1x
2x
2x
2x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
37x
37x
37x
37x
37x
1x
2x
2x
2x
2x
1x
2x
2x
2x
2x
2x
1x
2x
2x
2x
2x
2x
1x
2x
2x
2x
2x
2x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
1x
4x
4x
4x
4x
4x
| import { Command, CommandType } from './command'
import { FirmwareIndex } from '../powerblue_shades'
import { PBResponseBuffer } from './comms'
import { ControlService, ControlCharacteristic} from './control'
import { Buffer } from 'buffer/'
export class SetShadeModelCommand extends Command<PBResponseBuffer> {
constructor(firmwareIndex: FirmwareIndex, resetLimit: number = 0x00) {
super(ControlService, ControlCharacteristic, (encoder) => {
encoder.setHeader(0xFF, 0xFE);
encoder.addUInt16(firmwareIndex);
encoder.addUInt8(resetLimit);
});
this.name = "SetShadeModel";
}
}
export class SetShadeModelIndexCommand extends Command<PBResponseBuffer> {
constructor(index: number){
super(ControlService, ControlCharacteristic, (encoder) => {
encoder.setHeader(0xFF, 0xFE);
encoder.addUInt16(index);
encoder.addUInt8(0x00);
});
this.name = "SetShadeModelIndex";
}
}
/** Calibrate Shade - Run to top hard stall, and to bottom hard stall (unless it's a roller) */
export class FindAndSetLimitsCommand extends Command<PBResponseBuffer> {
constructor(runServo: boolean = true) {
super(ControlService, ControlCharacteristic, (encoder) => {
encoder.setHeader(0xF7, 0xD3);
encoder.addUInt8(runServo ? 0x01 : 0x00)
});
this.name = "FindAndSetLimits";
}
}
/** TODO - Define factory reset! */
export class FactoryResetCommand extends Command<PBResponseBuffer> {
constructor() {
super(ControlService, ControlCharacteristic, (encoder) => {
encoder.setHeader(0xFF, 0xEE);
});
this.name = "FactoryReset";
}
}
export enum OffsetType{
TopOffsetHere = 0x01,
BottomOffsetHere = 0x02 ,
BlackoutTransitionHere = 0x03,
/** *DEPRECATED* Don't you mean TiltTranstionHere! */
TiltOffsetHere = 0x04,
TiltTransitionHere = 0x07,
TopOffset = 0x11,
BottomOffset = 0x12,
BlackoutTransition = 0x13,
TiltOffset = 0x14,
TiltTransition = 0x17,
/** Sets the shade length in encoder counts. */
ShadeLength = 0x21,
/** Sets the Top Offset to the shade default - not always 0 */
ClearTopOffset = 0xE1,
ClearBottomOffset = 0xE2,
ClearBlackoutTransition = 0xE3,
ClearTiltOffset = 0xE4,
ClearTiltTransition = 0xE7
}
/** Set a variety of offset types */
export class SetOffsetCommand extends Command<PBResponseBuffer> {
constructor(offsetType: OffsetType, encoderOffset:number = 0x0000){
super(ControlService, ControlCharacteristic, (encoder) =>{
encoder.setHeader(ServoNumber.All, 0xD1);
encoder.addUInt8(offsetType);
// if(offsetType>OffsetType.TiltTransitionHere
// && offsetType<OffsetType.ClearTopOffset
// && encoderOffset != undefined){
encoder.addUInt16(encoderOffset);
// }
});
this.name = "SetOffset" + offsetType;
}
}
export interface MACAddressResponse {
error: number
rssi : number
shadeName : string
macAddress: Array<number>
}
export class GetMACAddressCommand extends Command<MACAddressResponse> {
constructor() {
super(ControlService, ControlCharacteristic, encoder => {
encoder.setHeader(0xff, 0x12);
}, CommandType.writeAndListen);
this.name = "GetMACAddress";
}
parseResponse = (inbuf: any): MACAddressResponse => {
if (!inbuf) { throw new Error("No response body"); }
const buff = Buffer.from(inbuf);
const error = buff.readUInt8(4)
const rssi = buff.readInt8(5)
const shadeName = decodeUTF8(buff.slice(6, 14));
const macAddress = Array.from(buff.slice(14, 20))
return {
error, rssi, shadeName, macAddress
}
};
}
/*
Velocity Commands
Note: THese are technically the same command but for readability it seems better to break them out by their keys
*/
export class SetDefaultVelocityCommand extends Command<PBResponseBuffer> {
constructor(velocity: number) {
super(ControlService, ControlCharacteristic, (encoder) => {
encoder.setHeader(0xF7, 0xD2);
encoder.addUInt8(0x01) // User Velocity Key
encoder.addUInt8(velocity);
});
this.name = "SetDefaultVelocity";
}
}
export class SetDefaultTiltVelocityCommand extends Command<PBResponseBuffer> {
constructor(velocity: number) {
super(ControlService, ControlCharacteristic, (encoder) => {
encoder.setHeader(0xF7, 0xD2);
encoder.addUInt8(0x04) // User Tilt Velocity Key
encoder.addUInt8(velocity);
});
this.name = "SetDefaultTiltVelocity";
}
}
export class ResetDefaultVelocityCommand extends Command<PBResponseBuffer> {
constructor() {
super(ControlService, ControlCharacteristic, (encoder) => {
encoder.setHeader(0xF7, 0xD2);
encoder.addUInt8(0xE1) // Reset Velocity Key
encoder.addUInt8(0x00);
});
this.name = "ResetDefaultVelocity";
}
}
/*
Diagnostic Commands
*/
export enum DiagnosticsType {
ShadeUptime = 0x01,
ShadeConfig = 0x02,
ShadeMetrics = 0x03,
ServoPositions = 0xF1,
ServoLimits = 0xD1
}
export enum ServoNumber {
All = 0xF7,
One = 0xF1,
Two = 0xF2
}
class DiagnosticsResponse extends PBResponseBuffer{
dataKey : number = 0x00;
constructor(byteArray: any){
super(byteArray)
this.dataKey = Buffer.from(byteArray).readUInt8(5);
}
}
// [Shade Length, Current Position, Tilt Offset, Position Error Offset]
export interface ServoPositionDiagnostics extends DiagnosticsResponse{
shadeLength: number;
currentPosition: number;
positionErrorOffset: number; // the difference between the position the shade was asked to go to vs what it ended up at
}
export interface ServoLimitOffsetDiagnostics extends DiagnosticsResponse {
topLimit: number;
bottomLimit: number;
topOffset: number;
bottomOffset: number;
tiltOffset: number;
}
export interface ServoMetrics extends DiagnosticsResponse {
hwFaultCnt: number;
wdtResetCnt: number;
softResetCnt: number;
systemResetCnt: number;
firmwareUpdateCnt: number;
currentFirmwareVersion: number;
lastFirmwareVersion: number;
maxStackUsage: number;
currentNordicTemperature: number;
maxNordicTemperature: number;
lastAssertCode: number;
presetTopCmdCnt: number;
presetTopOffsetCmdCnt: number;
presetBottomCmdCnt: number;
presetBottomOffsetCmdCnt: number;
presetTiltOpenCmdCnt: number;
presetTiltClosedCmdCnt: number;
presetHeartCmdCnt: number;
presetDoubleHeartCmdCnt: number;
presetCurrent: number; //current preset executed
presetPrevious: number; //previous preset executed
goToPresetCmdCnt: number;
stopCmdCnt: number;
goToPosCmdCnt: number;
jogCmdCnt: number;
numMovements: number;
avgAcceleration: number;
avgDeceleration: number;
avgConstantVelocity: number;
avgMoveTime: number;
avgMoveCnts: number;
motorRunTimeSec: number;
lowBatteryMoveCnt: number;
topOffsetSetCnt: number;
bottomOffsetSetCnt: number;
tiltOffsetSetCnt: number;
garbageCollectCnt: number;
}
export class GetDiagnostics extends Command<DiagnosticsResponse>{
constructor(diagnosticsType : DiagnosticsType, servoNumber : ServoNumber = ServoNumber.One){
super(ControlService, ControlCharacteristic, (encoder) =>{
encoder.setHeader(servoNumber, 0xDD);
encoder.addUInt8(diagnosticsType);
}, CommandType.writeAndListen);
this.name = "GetDiagnostics:" + diagnosticsType.toString(16);
}
parseResponse = (inbuf: any) : DiagnosticsResponse => {
if (!inbuf) { throw new Error("No response body"); }
let retval = new DiagnosticsResponse(inbuf);
let buffer = retval._buffer;
const diagnosticsKey = buffer.readUInt8(5);
switch(diagnosticsKey){
case DiagnosticsType.ServoLimits:
let slod = retval as ServoLimitOffsetDiagnostics;
slod.topLimit = buffer.readUInt32LE(6);
slod.bottomLimit = buffer.readUInt32LE(10);
slod.topOffset = buffer.readUInt16LE(14);
slod.bottomOffset = buffer.readUInt16LE(16);
slod.tiltOffset = buffer.readUInt16LE(18);
return slod;
break;
case DiagnosticsType.ServoPositions:
let spd = retval as ServoPositionDiagnostics
spd.shadeLength = buffer.readUInt32LE(6);
spd.currentPosition = buffer.readUInt32LE(10);
spd.positionErrorOffset = buffer.readUInt32LE(14);
return spd;
break;
case DiagnosticsType.ShadeConfig:
break;
case DiagnosticsType.ShadeMetrics:
let m = retval as ServoMetrics
m.hwFaultCnt = buffer.readUInt32LE(6); //6
m.wdtResetCnt = buffer.readUInt32LE(10);
m.softResetCnt = buffer.readUInt32LE(14);
m.systemResetCnt = buffer.readUInt32LE(18);
m.firmwareUpdateCnt = buffer.readUInt32LE(22);
m.currentFirmwareVersion = buffer.readUInt32LE(26);
m.lastFirmwareVersion = buffer.readUInt32LE(30);
m.maxStackUsage = buffer.readUInt32LE(34);
m.currentNordicTemperature = buffer.readInt32LE(38);
m.maxNordicTemperature = buffer.readInt32LE(42);
m.lastAssertCode = buffer.readUInt32LE(46);
//Movement Cmd Cnts
m.presetTopCmdCnt = buffer.readUInt32LE(50);
m.presetTopOffsetCmdCnt = buffer.readUInt32LE(54);
m.presetBottomCmdCnt = buffer.readUInt32LE(58);
m.presetBottomOffsetCmdCnt = buffer.readUInt32LE(62);
m.presetTiltOpenCmdCnt = buffer.readUInt32LE(66);
m.presetTiltClosedCmdCnt = buffer.readUInt32LE(70);
m.presetHeartCmdCnt = buffer.readUInt32LE(74);
m.presetDoubleHeartCmdCnt = buffer.readUInt32LE(78);
m.presetCurrent = buffer.readUInt32LE(82); //current preset executed
m.presetPrevious = buffer.readUInt32LE(86); //previous preset executed
m.goToPresetCmdCnt = buffer.readUInt32LE(90);
m.stopCmdCnt = buffer.readUInt32LE(94);
m.goToPosCmdCnt = buffer.readUInt32LE(98);
m.jogCmdCnt = buffer.readUInt32LE(102);
//Movement Data
m.numMovements = buffer.readUInt32LE(106);
m.avgAcceleration = buffer.readUInt32LE(110)
m.avgDeceleration = buffer.readUInt32LE(114);
m.avgConstantVelocity = buffer.readUInt32LE(118);
m.avgMoveTime = buffer.readUInt32LE(122);
m.avgMoveCnts = buffer.readUInt32LE(126);
m.motorRunTimeSec = buffer.readUInt32LE(130);
m.lowBatteryMoveCnt = buffer.readUInt32LE(134);
//Offset set counts
m.topOffsetSetCnt = buffer.readUInt32LE(138);
m.bottomOffsetSetCnt = buffer.readUInt32LE(142);
m.tiltOffsetSetCnt = buffer.readUInt32LE(146);
m.garbageCollectCnt = buffer.readUInt32LE(150);
return m;
break;
case DiagnosticsType.ShadeUptime:
break;
default:
break;
}
return retval;
}
}
// Unmarshals a string from an Uint8Array.
// Use this function instead of importing a huge library.
function decodeUTF8(bytes : any) {
var i = 0, s = '';
while (i < bytes.length) {
var c = bytes[i++];
if (c > 127) {
if (c > 191 && c < 224) {
if (i >= bytes.length)
throw new Error('UTF-8 decode: incomplete 2-byte sequence');
c = (c & 31) << 6 | bytes[i++] & 63;
} else if (c > 223 && c < 240) {
if (i + 1 >= bytes.length)
throw new Error('UTF-8 decode: incomplete 3-byte sequence');
c = (c & 15) << 12 | (bytes[i++] & 63) << 6 | bytes[i++] & 63;
} else if (c > 239 && c < 248) {
if (i + 2 >= bytes.length)
throw new Error('UTF-8 decode: incomplete 4-byte sequence');
c = (c & 7) << 18 | (bytes[i++] & 63) << 12 | (bytes[i++] & 63) << 6 | bytes[i++] & 63;
} else throw new Error('UTF-8 decode: unknown multibyte start 0x' + c.toString(16) + ' at index ' + (i - 1));
}
if (c <= 0xffff) s += String.fromCharCode(c);
else if (c <= 0x10ffff) {
c -= 0x10000;
s += String.fromCharCode(c >> 10 | 0xd800)
s += String.fromCharCode(c & 0x3FF | 0xdc00)
} else throw new Error('UTF-8 decode: code point 0x' + c.toString(16) + ' exceeds UTF-16 reach');
}
return s;
}
|