-
Notifications
You must be signed in to change notification settings - Fork 0
/
config.ts
433 lines (392 loc) · 11.9 KB
/
config.ts
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
import _ from 'lodash'
import os from 'os'
type GpioInputMode = 'ON_OFF' | 'TRIGGER'
type SensorModel = 'ADAFRUIT_BH1750'
type InputAction = 'STATUS' | 'BRIGHTNESS'
type InputPull = 'UP' | 'DOWN'
type OutputMode = 'ON_OFF' | 'PWM'
type TransformFunction = 'CONSTANT' | 'SIN' | 'LINEAR' | 'LOG' | 'EXP'
const SERVICE_PORT_DEFAULT = 8991
const SERVICE_NAME_DEFAULT = `on-air-box-${os.hostname()}`
const INPUT_DEBOUNCE_DELAY_DEFAULT = 50 // ms
const GPIO_INPUT_MODE_DEFAULT: GpioInputMode = 'ON_OFF'
const INPUT_ACTION_DEFAULT: InputAction = 'STATUS'
const INPUT_PULL_DEFAULT: InputPull = 'DOWN'
const SHOW_LOCAL_STATUS_ON_GLOBAL_OUTPUT_DEFAULT = false
const OUTPUT_MODE_DEFAULT: OutputMode = 'ON_OFF'
const OUTPUT_FUNCTION_PERIOD_DEFAULT: number = 2000 // ms
const BRIGHTNESS_DEFAULT = 0.6 // 0 - 1
export interface TransformFunctionRawConfig {
function: TransformFunction
value?: number
period?: number
offset?: number
min?: number
max?: number
coefficient?: number
}
export interface RawConfig {
statuses: string[]
defaultStatus: string
showLocalStatusOnGlobalOutput?: boolean
service?: {
port?: number
name?: string
}
box: {
// in ms (so default 50ms)
inputDebounceDelay?: number
// float between 0 and 1
defaultBrightness?: number
lightSensor?: {
model: SensorModel
address?: number
bus?: number
transform?: TransformFunctionRawConfig
}
inputsByName?: {
[name: string]:
| number
| {
type?: 'GPIO'
mode?: GpioInputMode
pull?: InputPull
pin: number
action?: InputAction
onValue?: any
offValue?: any
}
}
globalStatusOutputsByName?: {
[name: string]:
| number
| {
mode?: OutputMode
pin: number
range?: number
inverted?: boolean
}
}
localStatusOutputsByName?: {
[name: string]:
| number
| {
mode?: OutputMode
pin: number
range?: number
inverted?: boolean
}
}
outputsByStatus?: {
[status: string]: {
[name: string]: number | TransformFunctionRawConfig
}
}
}
}
export type ServiceConfig = Readonly<{
port: number
name: string
}>
export type InputGpioConfig = Readonly<{
type: 'GPIO'
name: string
mode: GpioInputMode
pull: InputPull
pin: number
action: InputAction
onValue?: any
offValue?: any
}>
export type InputConfig = InputGpioConfig
export type OutputConfig = Readonly<{
name: string
mode: OutputMode
pin: number
range: number
inverted: boolean
}>
interface CommonTransformConfig {
coefficient: number
offset: number
min?: number
max?: number
}
export type ConstantTransformConfig = {
function: 'CONSTANT'
value?: number
}
export type SinTransformConfig = CommonTransformConfig & {
function: 'SIN'
period: number
}
export type LinearTransformConfig = CommonTransformConfig & {
function: 'LINEAR'
}
export type LogTransformConfig = CommonTransformConfig & {
function: 'LOG'
}
export type ExpTransformConfig = CommonTransformConfig & {
function: 'EXP'
}
export type TransformConfig = Readonly<
| ConstantTransformConfig
| SinTransformConfig
| LinearTransformConfig
| LogTransformConfig
| ExpTransformConfig
>
export type BoxConfig = Readonly<{
inputDebounceDelay: number
defaultBrightness: number
lightSensor?: {
model: SensorModel
address: number
bus: number
transform: TransformConfig
}
inputsByName?: Map<string, InputConfig>
globalStatusOutputsByName?: Map<string, OutputConfig>
localStatusOutputsByName?: Map<string, OutputConfig>
outputTransformsByStatus?: Map<string, Map<string, TransformConfig>>
}>
export type Config = Readonly<{
statuses: Array<string>
defaultStatus: string
showLocalStatusOnGlobalOutput: boolean
service: ServiceConfig
box: BoxConfig
}>
const DEFAULT_PWM_RANGE = 255
export function parseConfig(rawConfig: RawConfig): Readonly<Config> {
if (!rawConfig.statuses?.length)
throw new TypeError(`Must provide at least one status in "statuses"`)
if (!rawConfig.defaultStatus?.length)
throw new TypeError(`Must provide defaultStatus`)
if (
!rawConfig.box.globalStatusOutputsByName !== !rawConfig.box.outputsByStatus
)
throw new TypeError(
`outputByName supplied without any outputValuesByStatus or vice versa`
)
if (!rawConfig.box.inputsByName && !rawConfig.box.globalStatusOutputsByName)
throw new TypeError(
`Must provide either input config, or output config, or both (otherwise Box won't have anything to do!)`
)
let statuses = rawConfig.statuses.slice()
let showLocalStatusOnGlobalOutput = _.defaultTo(
rawConfig.showLocalStatusOnGlobalOutput,
SHOW_LOCAL_STATUS_ON_GLOBAL_OUTPUT_DEFAULT
)
let service = {
port: _.defaultTo(rawConfig.service?.port, SERVICE_PORT_DEFAULT),
name: _.defaultTo(rawConfig.service?.name, SERVICE_NAME_DEFAULT),
}
const inputDebounceDelay = _.defaultTo(
rawConfig.box.inputDebounceDelay,
INPUT_DEBOUNCE_DELAY_DEFAULT
)
const defaultBrightness = _.defaultTo(
rawConfig.box.defaultBrightness,
BRIGHTNESS_DEFAULT
)
let lightSensor
if (rawConfig.box.lightSensor) {
let brightnessTransform: TransformConfig
if (!rawConfig.box.lightSensor.transform) {
// pretty good curve, looks like this: https://www.desmos.com/calculator/oqgxlgud8o
// calculated here: https://keisan.casio.com/exec/system/14059930226691
brightnessTransform = {
function: 'LOG',
coefficient: 0.13,
offset: -0.0967,
min: 0.05,
max: rawConfig.box.defaultBrightness,
}
} else {
switch (rawConfig.box.lightSensor.transform?.function) {
case 'LINEAR':
brightnessTransform = {
function: 'LINEAR',
coefficient: _.defaultTo(
rawConfig.box.lightSensor.transform.coefficient,
1
),
offset: _.defaultTo(rawConfig.box.lightSensor.transform.offset, 0),
min: rawConfig.box.lightSensor.transform.min,
max: rawConfig.box.lightSensor.transform.max,
}
break
case 'LOG':
brightnessTransform = {
function: 'LOG',
coefficient: _.defaultTo(
rawConfig.box.lightSensor.transform.coefficient,
1
),
offset: _.defaultTo(rawConfig.box.lightSensor.transform.offset, 0),
min: rawConfig.box.lightSensor.transform.min,
max: rawConfig.box.lightSensor.transform.max,
}
break
default:
throw new TypeError(
`lightSensor transform function ${rawConfig.box.lightSensor.transform.function} not yet implemented`
)
}
}
lightSensor = {
model: rawConfig.box.lightSensor.model,
address: _.defaultTo(rawConfig.box.lightSensor.address, 0x23),
bus: _.defaultTo(rawConfig.box.lightSensor.bus, 1),
transform: brightnessTransform,
}
}
const inputsByName: Map<string, InputConfig> | undefined =
rawConfig.box.inputsByName &&
new Map(
Object.entries(rawConfig.box.inputsByName).map(
([name, input]): [string, InputConfig] => {
if (typeof input === 'number') {
input = { type: 'GPIO', pin: input }
}
// if (input.type === 'GPIO') {
const mode = input.mode || GPIO_INPUT_MODE_DEFAULT
const pull = input.pull || INPUT_PULL_DEFAULT
const action = input.action || INPUT_ACTION_DEFAULT
if (!input.onValue && !input.offValue)
throw new TypeError(
`Missing onValue/offValue option for input ${name} with mode "${input.mode}"`
)
return [
name,
{
type: 'GPIO',
name,
mode,
pull,
pin: input.pin,
action: action,
onValue: input.onValue,
offValue: input.offValue,
},
]
}
)
)
const globalStatusOutputsByName: Map<string, OutputConfig> | undefined =
getOutputMap(rawConfig.box.globalStatusOutputsByName)
const localStatusOutputsByName: Map<string, OutputConfig> | undefined =
getOutputMap(rawConfig.box.localStatusOutputsByName)
const outputTransformsByStatus:
| Map<string, Map<string, TransformConfig>>
| undefined =
rawConfig.box.outputsByStatus &&
new Map(
Object.entries(rawConfig.box.outputsByStatus).map(
([status, outputValues]) => {
if (!statuses.includes(status))
throw new TypeError(
`Invalid status ${status}; not present in statuses array`
)
return [
status,
new Map(
Object.entries(outputValues).map(([name, value]) => {
const output = globalStatusOutputsByName?.get(name)
if (output === undefined)
throw new TypeError(`Unknown output with name ${name}`)
if (typeof value === 'number') {
value = {
function: 'CONSTANT',
value,
}
}
let outputTransform: TransformConfig
if (value.function === 'CONSTANT') {
if (
value.value === undefined ||
value.value < 0 ||
value.value > output.range
) {
throw new TypeError(
`Invalid output value of ${value}; must be number within output ${output.name} range 0 - ${output.range}`
)
}
outputTransform = {
function: 'CONSTANT',
value: value.value,
}
} else if (value.function === 'SIN') {
outputTransform = {
function: 'SIN',
period: _.defaultTo(
value.period,
OUTPUT_FUNCTION_PERIOD_DEFAULT
),
coefficient: _.defaultTo(value.coefficient, 1),
offset: _.defaultTo(value.offset, 0),
min: _.defaultTo(value.min, 0),
max: _.defaultTo(value.max, output.range),
}
} else {
throw new TypeError(
`Output transform ${value.function} not implemented yet!`
)
}
return [name, outputTransform]
})
),
]
}
)
)
return {
statuses,
defaultStatus: rawConfig.defaultStatus,
showLocalStatusOnGlobalOutput,
service,
box: {
inputDebounceDelay,
defaultBrightness,
lightSensor,
inputsByName,
globalStatusOutputsByName: globalStatusOutputsByName,
localStatusOutputsByName: localStatusOutputsByName,
outputTransformsByStatus: outputTransformsByStatus,
},
}
}
function getOutputMap(
outputsByName: RawConfig['box']['globalStatusOutputsByName']
): Map<string, OutputConfig> | undefined {
return (
outputsByName &&
new Map(
Object.entries(outputsByName).map(([name, output]) => {
if (typeof output === 'number') {
output = { pin: output }
}
const mode = output.mode || OUTPUT_MODE_DEFAULT
const range = _.defaultTo(
output.range,
mode === 'ON_OFF' ? 1 : DEFAULT_PWM_RANGE
)
if (mode === 'ON_OFF' && range !== 1)
throw new TypeError(
`Invalid range ${output.range} for binary output ${name}. If specified, range must be 1`
)
return [
name,
{
name,
mode,
range,
pin: output.pin,
inverted: output.inverted === true,
},
]
})
)
)
}