forked from brocaar/chirpstack-application-server
/
device.go
611 lines (528 loc) · 15.5 KB
/
device.go
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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
package storage
import (
"context"
"strings"
"time"
uuid "github.com/gofrs/uuid"
"github.com/jmoiron/sqlx"
"github.com/pkg/errors"
log "github.com/sirupsen/logrus"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"github.com/brocaar/lora-app-server/internal/config"
"github.com/brocaar/loraserver/api/ns"
"github.com/brocaar/lorawan"
)
// Device defines a LoRaWAN device.
type Device struct {
DevEUI lorawan.EUI64 `db:"dev_eui"`
CreatedAt time.Time `db:"created_at"`
UpdatedAt time.Time `db:"updated_at"`
LastSeenAt *time.Time `db:"last_seen_at"`
ApplicationID int64 `db:"application_id"`
DeviceProfileID uuid.UUID `db:"device_profile_id"`
Name string `db:"name"`
Description string `db:"description"`
SkipFCntCheck bool `db:"-"`
ReferenceAltitude float64 `db:"-"`
DeviceStatusBattery *float32 `db:"device_status_battery"`
DeviceStatusMargin *int `db:"device_status_margin"`
DeviceStatusExternalPower bool `db:"device_status_external_power_source"`
Latitude *float64 `db:"latitude"`
Longitude *float64 `db:"longitude"`
Altitude *float64 `db:"altitude"`
}
// DeviceListItem defines the Device as list item.
type DeviceListItem struct {
Device
DeviceProfileName string `db:"device_profile_name"`
}
// Validate validates the device data.
func (d Device) Validate() error {
return nil
}
// DeviceKeys defines the keys for a LoRaWAN device.
type DeviceKeys struct {
CreatedAt time.Time `db:"created_at"`
UpdatedAt time.Time `db:"updated_at"`
DevEUI lorawan.EUI64 `db:"dev_eui"`
NwkKey lorawan.AES128Key `db:"nwk_key"`
AppKey lorawan.AES128Key `db:"app_key"`
JoinNonce int `db:"join_nonce"`
}
// DeviceActivation defines the device-activation for a LoRaWAN device.
type DeviceActivation struct {
ID int64 `db:"id"`
CreatedAt time.Time `db:"created_at"`
DevEUI lorawan.EUI64 `db:"dev_eui"`
DevAddr lorawan.DevAddr `db:"dev_addr"`
AppSKey lorawan.AES128Key `db:"app_s_key"`
}
// CreateDevice creates the given device.
func CreateDevice(db sqlx.Ext, d *Device) error {
if err := d.Validate(); err != nil {
return errors.Wrap(err, "validate error")
}
now := time.Now()
d.CreatedAt = now
d.UpdatedAt = now
_, err := db.Exec(`
insert into device (
dev_eui,
created_at,
updated_at,
application_id,
device_profile_id,
name,
description,
device_status_battery,
device_status_margin,
device_status_external_power_source,
last_seen_at,
latitude,
longitude,
altitude
) values ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14)`,
d.DevEUI[:],
d.CreatedAt,
d.UpdatedAt,
d.ApplicationID,
d.DeviceProfileID,
d.Name,
d.Description,
d.DeviceStatusBattery,
d.DeviceStatusMargin,
d.DeviceStatusExternalPower,
d.LastSeenAt,
d.Latitude,
d.Longitude,
d.Altitude,
)
if err != nil {
return handlePSQLError(Insert, err, "insert error")
}
app, err := GetApplication(db, d.ApplicationID)
if err != nil {
return errors.Wrap(err, "get application error")
}
n, err := GetNetworkServerForDevEUI(db, d.DevEUI)
if err != nil {
return errors.Wrap(err, "get network-server error")
}
nsClient, err := config.C.NetworkServer.Pool.Get(n.Server, []byte(n.CACert), []byte(n.TLSCert), []byte(n.TLSKey))
if err != nil {
return errors.Wrap(err, "get network-server client error")
}
rpID, err := uuid.FromString(config.C.ApplicationServer.ID)
if err != nil {
return errors.Wrap(err, "uuid from string error")
}
_, err = nsClient.CreateDevice(context.Background(), &ns.CreateDeviceRequest{
Device: &ns.Device{
DevEui: d.DevEUI[:],
DeviceProfileId: d.DeviceProfileID.Bytes(),
ServiceProfileId: app.ServiceProfileID.Bytes(),
RoutingProfileId: rpID.Bytes(),
SkipFCntCheck: d.SkipFCntCheck,
ReferenceAltitude: d.ReferenceAltitude,
},
})
if err != nil {
log.WithError(err).Error("network-server create device api error")
return handleGrpcError(err, "create device error")
}
log.WithFields(log.Fields{
"dev_eui": d.DevEUI,
}).Info("device created")
return nil
}
// GetDevice returns the device matching the given DevEUI.
// When forUpdate is set to true, then db must be a db transaction.
// When localOnly is set to true, no call to the network-server is made to
// retrieve additional device data.
func GetDevice(db sqlx.Queryer, devEUI lorawan.EUI64, forUpdate, localOnly bool) (Device, error) {
var fu string
if forUpdate {
fu = " for update"
}
var d Device
err := sqlx.Get(db, &d, "select * from device where dev_eui = $1"+fu, devEUI[:])
if err != nil {
return d, handlePSQLError(Select, err, "select error")
}
if localOnly {
return d, nil
}
n, err := GetNetworkServerForDevEUI(db, d.DevEUI)
if err != nil {
return d, errors.Wrap(err, "get network-server error")
}
nsClient, err := config.C.NetworkServer.Pool.Get(n.Server, []byte(n.CACert), []byte(n.TLSCert), []byte(n.TLSKey))
if err != nil {
return d, errors.Wrap(err, "get network-server client error")
}
resp, err := nsClient.GetDevice(context.Background(), &ns.GetDeviceRequest{
DevEui: d.DevEUI[:],
})
if err != nil {
return d, err
}
if resp.Device != nil {
d.SkipFCntCheck = resp.Device.SkipFCntCheck
d.ReferenceAltitude = resp.Device.ReferenceAltitude
}
return d, nil
}
// DeviceFilters provide filters that can be used to filter on devices.
// Note that empty values are not used as filter.
type DeviceFilters struct {
ApplicationID int64 `db:"application_id"`
MulticastGroupID uuid.UUID `db:"multicast_group_id"`
ServiceProfileID uuid.UUID `db:"service_profile_id"`
Search string `db:"search"`
// Limit and Offset are added for convenience so that this struct can
// be given as the arguments.
Limit int `db:"limit"`
Offset int `db:"offset"`
}
// SQL returns the SQL filter.
func (f DeviceFilters) SQL() string {
var filters []string
if f.ApplicationID != 0 {
filters = append(filters, "d.application_id = :application_id")
}
if f.MulticastGroupID != uuid.Nil {
filters = append(filters, "dmg.multicast_group_id = :multicast_group_id")
}
if f.ServiceProfileID != uuid.Nil {
filters = append(filters, "a.service_profile_id = :service_profile_id")
}
if f.Search != "" {
filters = append(filters, "(d.name ilike :search or encode(d.dev_eui, 'hex') ilike :search)")
}
if len(filters) == 0 {
return ""
}
return "where " + strings.Join(filters, " and ")
}
// GetDeviceCount returns the number of devices.
func GetDeviceCount(db sqlx.Queryer, filters DeviceFilters) (int, error) {
if filters.Search != "" {
filters.Search = "%" + filters.Search + "%"
}
query, args, err := sqlx.BindNamed(sqlx.DOLLAR, `
select
count(distinct d.*)
from device d
inner join application a
on d.application_id = a.id
left join device_multicast_group dmg
on d.dev_eui = dmg.dev_eui
`+filters.SQL(), filters)
if err != nil {
return 0, errors.Wrap(err, "named query error")
}
var count int
err = sqlx.Get(db, &count, query, args...)
if err != nil {
return 0, handlePSQLError(Select, err, "select error")
}
return count, nil
}
// GetDevices returns a slice of devices.
func GetDevices(db sqlx.Queryer, filters DeviceFilters) ([]DeviceListItem, error) {
if filters.Search != "" {
filters.Search = "%" + filters.Search + "%"
}
query, args, err := sqlx.BindNamed(sqlx.DOLLAR, `
select
distinct d.*,
dp.name as device_profile_name
from
device d
inner join device_profile dp
on dp.device_profile_id = d.device_profile_id
inner join application a
on d.application_id = a.id
left join device_multicast_group dmg
on d.dev_eui = dmg.dev_eui
`+filters.SQL()+`
order by
d.name
limit :limit
offset :offset
`, filters)
if err != nil {
return nil, errors.Wrap(err, "named query error")
}
var devices []DeviceListItem
err = sqlx.Select(db, &devices, query, args...)
if err != nil {
return nil, handlePSQLError(Select, err, "select error")
}
return devices, nil
}
// UpdateDevice updates the given device.
// When localOnly is set, it will not update the device on the network-server.
func UpdateDevice(db sqlx.Ext, d *Device, localOnly bool) error {
if err := d.Validate(); err != nil {
return errors.Wrap(err, "validate error")
}
d.UpdatedAt = time.Now()
res, err := db.Exec(`
update device
set
updated_at = $2,
application_id = $3,
device_profile_id = $4,
name = $5,
description = $6,
device_status_battery = $7,
device_status_margin = $8,
last_seen_at = $9,
latitude = $10,
longitude = $11,
altitude = $12,
device_status_external_power_source = $13
where
dev_eui = $1`,
d.DevEUI[:],
d.UpdatedAt,
d.ApplicationID,
d.DeviceProfileID,
d.Name,
d.Description,
d.DeviceStatusBattery,
d.DeviceStatusMargin,
d.LastSeenAt,
d.Latitude,
d.Longitude,
d.Altitude,
d.DeviceStatusExternalPower,
)
if err != nil {
return handlePSQLError(Update, err, "update error")
}
ra, err := res.RowsAffected()
if err != nil {
return errors.Wrap(err, "get rows affected error")
}
if ra == 0 {
return ErrDoesNotExist
}
// update the device on the network-server
if !localOnly {
app, err := GetApplication(db, d.ApplicationID)
if err != nil {
return errors.Wrap(err, "get application error")
}
n, err := GetNetworkServerForDevEUI(db, d.DevEUI)
if err != nil {
return errors.Wrap(err, "get network-server error")
}
nsClient, err := config.C.NetworkServer.Pool.Get(n.Server, []byte(n.CACert), []byte(n.TLSCert), []byte(n.TLSKey))
if err != nil {
return errors.Wrap(err, "get network-server client error")
}
rpID, err := uuid.FromString(config.C.ApplicationServer.ID)
if err != nil {
return errors.Wrap(err, "uuid from string error")
}
_, err = nsClient.UpdateDevice(context.Background(), &ns.UpdateDeviceRequest{
Device: &ns.Device{
DevEui: d.DevEUI[:],
DeviceProfileId: d.DeviceProfileID.Bytes(),
ServiceProfileId: app.ServiceProfileID.Bytes(),
RoutingProfileId: rpID.Bytes(),
SkipFCntCheck: d.SkipFCntCheck,
ReferenceAltitude: d.ReferenceAltitude,
},
})
if err != nil {
log.WithError(err).Error("network-server update device api error")
return handleGrpcError(err, "update device error")
}
}
log.WithFields(log.Fields{
"dev_eui": d.DevEUI,
}).Info("device updated")
return nil
}
// DeleteDevice deletes the device matching the given DevEUI.
func DeleteDevice(db sqlx.Ext, devEUI lorawan.EUI64) error {
n, err := GetNetworkServerForDevEUI(db, devEUI)
if err != nil {
return errors.Wrap(err, "get network-server error")
}
res, err := db.Exec("delete from device where dev_eui = $1", devEUI[:])
if err != nil {
return handlePSQLError(Delete, err, "delete error")
}
ra, err := res.RowsAffected()
if err != nil {
return errors.Wrap(err, "get rows affected error")
}
if ra == 0 {
return ErrDoesNotExist
}
nsClient, err := config.C.NetworkServer.Pool.Get(n.Server, []byte(n.CACert), []byte(n.TLSCert), []byte(n.TLSKey))
if err != nil {
return errors.Wrap(err, "get network-server client error")
}
_, err = nsClient.DeleteDevice(context.Background(), &ns.DeleteDeviceRequest{
DevEui: devEUI[:],
})
if err != nil && grpc.Code(err) != codes.NotFound {
log.WithError(err).Error("network-server delete device api error")
return handleGrpcError(err, "delete device error")
}
log.WithFields(log.Fields{
"dev_eui": devEUI,
}).Info("device deleted")
return nil
}
// CreateDeviceKeys creates the keys for the given device.
func CreateDeviceKeys(db sqlx.Execer, dc *DeviceKeys) error {
now := time.Now()
dc.CreatedAt = now
dc.UpdatedAt = now
_, err := db.Exec(`
insert into device_keys (
created_at,
updated_at,
dev_eui,
nwk_key,
app_key,
join_nonce
) values ($1, $2, $3, $4, $5, $6)`,
dc.CreatedAt,
dc.UpdatedAt,
dc.DevEUI[:],
dc.NwkKey[:],
dc.AppKey[:],
dc.JoinNonce,
)
if err != nil {
return handlePSQLError(Insert, err, "insert error")
}
log.WithFields(log.Fields{
"dev_eui": dc.DevEUI,
}).Info("device-keys created")
return nil
}
// GetDeviceKeys returns the device-keys for the given DevEUI.
func GetDeviceKeys(db sqlx.Queryer, devEUI lorawan.EUI64) (DeviceKeys, error) {
var dc DeviceKeys
err := sqlx.Get(db, &dc, "select * from device_keys where dev_eui = $1", devEUI[:])
if err != nil {
return dc, handlePSQLError(Select, err, "select error")
}
return dc, nil
}
// UpdateDeviceKeys updates the given device-keys.
func UpdateDeviceKeys(db sqlx.Execer, dc *DeviceKeys) error {
dc.UpdatedAt = time.Now()
res, err := db.Exec(`
update device_keys
set
updated_at = $2,
nwk_key = $3,
app_key = $4,
join_nonce = $5
where
dev_eui = $1`,
dc.DevEUI[:],
dc.UpdatedAt,
dc.NwkKey[:],
dc.AppKey[:],
dc.JoinNonce,
)
if err != nil {
return handlePSQLError(Update, err, "update error")
}
ra, err := res.RowsAffected()
if err != nil {
return errors.Wrap(err, "get rows affected error")
}
if ra == 0 {
return ErrDoesNotExist
}
log.WithFields(log.Fields{
"dev_eui": dc.DevEUI,
}).Info("device-keys updated")
return nil
}
// DeleteDeviceKeys deletes the device-keys for the given DevEUI.
func DeleteDeviceKeys(db sqlx.Execer, devEUI lorawan.EUI64) error {
res, err := db.Exec("delete from device_keys where dev_eui = $1", devEUI[:])
if err != nil {
return handlePSQLError(Delete, err, "delete error")
}
ra, err := res.RowsAffected()
if err != nil {
return errors.Wrap(err, "get rows affected errro")
}
if ra == 0 {
return ErrDoesNotExist
}
log.WithField("dev_eui", devEUI).Info("device-keys deleted")
return nil
}
// CreateDeviceActivation creates the given device-activation.
func CreateDeviceActivation(db sqlx.Queryer, da *DeviceActivation) error {
da.CreatedAt = time.Now()
err := sqlx.Get(db, &da.ID, `
insert into device_activation (
created_at,
dev_eui,
dev_addr,
app_s_key
) values ($1, $2, $3, $4)
returning id`,
da.CreatedAt,
da.DevEUI[:],
da.DevAddr[:],
da.AppSKey[:],
)
if err != nil {
return handlePSQLError(Insert, err, "insert error")
}
log.WithFields(log.Fields{
"id": da.ID,
"dev_eui": da.DevEUI,
}).Info("device-activation created")
return nil
}
// GetLastDeviceActivationForDevEUI returns the most recent device-activation for the given DevEUI.
func GetLastDeviceActivationForDevEUI(db sqlx.Queryer, devEUI lorawan.EUI64) (DeviceActivation, error) {
var da DeviceActivation
err := sqlx.Get(db, &da, `
select *
from device_activation
where
dev_eui = $1
order by
created_at desc
limit 1`,
devEUI[:],
)
if err != nil {
return da, handlePSQLError(Select, err, "select error")
}
return da, nil
}
// DeleteAllDevicesForApplicationID deletes all devices given an application id.
func DeleteAllDevicesForApplicationID(db sqlx.Ext, applicationID int64) error {
var devs []Device
err := sqlx.Select(db, &devs, "select * from device where application_id = $1", applicationID)
if err != nil {
return handlePSQLError(Select, err, "select error")
}
for _, dev := range devs {
err = DeleteDevice(db, dev.DevEUI)
if err != nil {
return errors.Wrap(err, "delete device error")
}
}
return nil
}