-
Notifications
You must be signed in to change notification settings - Fork 299
/
objects.go
347 lines (302 loc) · 9.46 KB
/
objects.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
// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package objects
import (
"encoding/hex"
"encoding/json"
"fmt"
"strings"
"go.thethings.network/lorawan-stack/v3/pkg/errors"
"go.thethings.network/lorawan-stack/v3/pkg/types"
)
// Implemented as per https://www.loracloud.com/documentation/device_management?url=v1.html#object-formats
// DeviceUplinkResponse contains the uplink response and the error if applicable.
type DeviceUplinkResponse struct {
Result ExtendedUplinkResponse `json:"result"`
Error string `json:"error"`
}
// DeviceUplinkResponses maps the device EUIs to the DeviceUplinkResponse.
type DeviceUplinkResponses map[EUI]DeviceUplinkResponse
// UnmarshalJSON implements json.Unmarshaler.
func (d DeviceUplinkResponses) UnmarshalJSON(b []byte) error {
m := make(map[string]DeviceUplinkResponse)
err := json.Unmarshal(b, &m)
if err != nil {
return err
}
for k, v := range m {
eui, err := toEUI(k)
if err != nil {
return err
}
d[eui] = v
}
return nil
}
// PositionSolutionType is the algorithm used by a position solution query.
type PositionSolutionType uint8
const (
// GNSSPositionSolutionType is GNSS position solution type.
GNSSPositionSolutionType PositionSolutionType = iota
// WiFiPositionSolutionType is WiFi position solution type.
WiFiPositionSolutionType
// UnknownPositionSolutionType is used when the position solution type is unknown.
UnknownPositionSolutionType
)
// PositionSolution is the result of a position query.
type PositionSolution struct {
Algorithm PositionSolutionType `json:"algorithm_type"`
LLH []float64 `json:"llh"`
Accuracy float64 `json:"accuracy"`
}
const (
gnssPositionSolutionType = "gnss"
wifiPositionSolutionType = "wifi"
unknownPositionSolutionType = "unknown"
)
// MarshalJSON implements the json.Marshaler interface.
func (t PositionSolutionType) MarshalJSON() ([]byte, error) {
var tp string
switch t {
case GNSSPositionSolutionType:
tp = gnssPositionSolutionType
case WiFiPositionSolutionType:
tp = wifiPositionSolutionType
default:
tp = unknownPositionSolutionType
}
return json.Marshal(tp)
}
// UnmarshalJSON implements the json.Unarmshaler.
func (t *PositionSolutionType) UnmarshalJSON(b []byte) error {
var tp string
err := json.Unmarshal(b, &tp)
if err != nil {
return err
}
switch tp {
case gnssPositionSolutionType:
*t = GNSSPositionSolutionType
case wifiPositionSolutionType:
*t = WiFiPositionSolutionType
default:
*t = UnknownPositionSolutionType
}
return nil
}
// String implements fmt.Stringer.
func (t PositionSolutionType) String() string {
switch t {
case GNSSPositionSolutionType:
return gnssPositionSolutionType
case WiFiPositionSolutionType:
return wifiPositionSolutionType
default:
return unknownPositionSolutionType
}
}
// StreamRecord contains the offset and the data of a fully reconstructed stream frame.
type StreamRecord struct {
Offset uint32
Data Hex
}
// MarshalJSON implements json.Marshaler.
func (r StreamRecord) MarshalJSON() ([]byte, error) {
return json.Marshal([]interface{}{r.Offset, r.Data})
}
var errInvalidStreamRecord = errors.DefineCorruption("invalid_stream_record", "invalid stream record")
// UnmarshalJSON implements json.Marshaler.
func (r *StreamRecord) UnmarshalJSON(b []byte) error {
raw := make([]json.RawMessage, 0, 2)
if err := json.Unmarshal(b, &raw); err != nil {
return err
}
if len(raw) != 2 {
return errInvalidStreamRecord.New()
}
if err := json.Unmarshal(raw[0], &r.Offset); err != nil {
return err
}
return json.Unmarshal(raw[1], &r.Data)
}
// UplinkResponse contains the state changes and completed items due to an uplink message.
type UplinkResponse struct {
Downlink *LoRaDnlink `json:"dnlink"`
StreamRecords []StreamRecord `json:"stream_records"`
Position *PositionSolution `json:"position_solution"`
}
// ExtendedUplinkResponse extends UplinkResponse with the raw JSON payload.
type ExtendedUplinkResponse struct {
UplinkResponse
Raw *json.RawMessage
}
// MarshalJSON implements json.Marshaler.
// Note that the Raw representation takes precedence
// in the marshaling process, if it is available.
func (r ExtendedUplinkResponse) MarshalJSON() ([]byte, error) {
if r.Raw != nil {
return r.Raw.MarshalJSON()
}
return json.Marshal(r.UplinkResponse)
}
// UnmarshalJSON implements json.Marshaler.
func (r *ExtendedUplinkResponse) UnmarshalJSON(b []byte) error {
r.Raw = &json.RawMessage{}
if err := r.Raw.UnmarshalJSON(b); err != nil {
return err
}
return json.Unmarshal(b, &r.UplinkResponse)
}
// DeviceUplinks maps device EUIs to LoRaUplink
type DeviceUplinks map[EUI]*LoRaUplink
// MarshalJSON implements json.Marshaler.
func (u DeviceUplinks) MarshalJSON() ([]byte, error) {
m := make(map[string]*LoRaUplink)
for k, v := range u {
m[k.String()] = v
}
return json.Marshal(m)
}
// LoRaUplink encapsulates the information of a LoRa message.
type LoRaUplink struct {
Type LoRaUplinkType `json:"msgtype"`
FCnt *uint32 `json:"fcnt,omitempty"`
Port *uint8 `json:"port,omitempty"`
Payload *Hex `json:"payload,omitempty"`
DR *uint8 `json:"dr,omitempty"`
Freq *uint32 `json:"freq,omitempty"`
Timestamp *float64 `json:"timestamp,omitempty"`
DownlinkMTU *uint32 `json:"dn_mtu,omitempty"`
GNSSCaptureTime *float64 `json:"gnss_capture_time,omitempty"`
GNSSCaptureTimeAccuracy *float64 `json:"gnss_capture_time_accuracy,omitempty"`
GNSSAssistPosition []float64 `json:"gnss_assist_position,omitempty"`
GNSSAssistAltitude *float64 `json:"gnss_assist_altitude,omitempty"`
GNSSUse2DSolver *bool `json:"gnss_use_2D_solver,omitempty"`
}
// LoRaUplinkType is the type of a LoRaCloud DMS uplink.
type LoRaUplinkType uint8
const (
// UplinkUplinkType is LoRaWAN Message Type.
UplinkUplinkType LoRaUplinkType = iota
// ModemUplinkType is DMS Protocol Message Type.
ModemUplinkType
// JoiningUplinkType is Session Reset Message Type.
JoiningUplinkType
// GNSSUplinkType is DMS GNSS Message Type.
GNSSUplinkType
// WiFiUplinkType is DMS WiFi Message Type.
WiFiUplinkType
// UnknownUplinkType is used when the uplink type is unknown.
UnknownUplinkType
)
const (
uplinkUplinkType = "updf"
modemUplinkType = "modem"
joiningUplinkType = "joining"
gnssUplinkType = "gnss"
wifiUplinkType = "wifi"
unknownUplinkType = "unknown"
)
// MarshalJSON implements the json.Marshaler interface.
func (t LoRaUplinkType) MarshalJSON() ([]byte, error) {
var tp string
switch t {
case UplinkUplinkType:
tp = uplinkUplinkType
case ModemUplinkType:
tp = modemUplinkType
case JoiningUplinkType:
tp = joiningUplinkType
case GNSSUplinkType:
tp = gnssUplinkType
case WiFiUplinkType:
tp = wifiUplinkType
default:
tp = unknownUplinkType
}
return json.Marshal(tp)
}
// UnmarshalJSON implements the json.Unarmshaler.
func (t *LoRaUplinkType) UnmarshalJSON(b []byte) error {
var tp string
err := json.Unmarshal(b, &tp)
if err != nil {
return err
}
switch tp {
case uplinkUplinkType:
*t = UplinkUplinkType
case modemUplinkType:
*t = ModemUplinkType
case joiningUplinkType:
*t = JoiningUplinkType
case gnssUplinkType:
*t = GNSSUplinkType
case wifiUplinkType:
*t = WiFiUplinkType
default:
*t = UnknownUplinkType
}
return nil
}
// LoRaDnlink is a specification for a modem device.
type LoRaDnlink struct {
Port uint8 `json:"port"`
Payload Hex `json:"payload"`
}
// Fields implements log.Fielder.
func (u LoRaDnlink) Fields() map[string]interface{} {
return map[string]interface{}{
"port": u.Port,
"payload": u.Payload,
}
}
// Hex represents hex encoded bytes.
type Hex []byte
// MarshalJSON implements json.Marshaler.
func (h Hex) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf("\"%s\"", hex.EncodeToString(h))), nil
}
// String implements fmt.Stringer.
func (h Hex) String() string {
return hex.EncodeToString(h)
}
// UnmarshalJSON implements json.Unmarshaler.
func (h *Hex) UnmarshalJSON(b []byte) (err error) {
s := strings.TrimSuffix(strings.TrimPrefix(string(b), "\""), "\"")
*h, err = hex.DecodeString(s)
return err
}
// EUI represents a dash-separated EUI64.
type EUI types.EUI64
const (
hyphenatedEUIPattern = "\"%02X-%02X-%02X-%02X-%02X-%02X-%02X-%02X\""
euiPattern = "%02X-%02X-%02X-%02X-%02X-%02X-%02X-%02X"
)
// MarshalJSON implements json.Marshaler.
func (e EUI) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(hyphenatedEUIPattern, e[0], e[1], e[2], e[3], e[4], e[5], e[6], e[7])), nil
}
// UnmarshalJSON implements json.Unmarshaler.
func (e *EUI) UnmarshalJSON(b []byte) error {
_, err := fmt.Sscanf(string(b), hyphenatedEUIPattern, &e[0], &e[1], &e[2], &e[3], &e[4], &e[5], &e[6], &e[7])
return err
}
func (e EUI) String() string {
return fmt.Sprintf(euiPattern, e[0], e[1], e[2], e[3], e[4], e[5], e[6], e[7])
}
func toEUI(s string) (e EUI, err error) {
_, err = fmt.Sscanf(s, euiPattern, &e[0], &e[1], &e[2], &e[3], &e[4], &e[5], &e[6], &e[7])
return e, err
}