forked from actility/device-catalog
-
Notifications
You must be signed in to change notification settings - Fork 0
/
model.yaml
67 lines (65 loc) · 3.45 KB
/
model.yaml
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
# Commercial name of the model
name: Sample Model
# Functional description of the product. Maximum 500 characters.
description: This a description of the functionalities of the sample model.
# Logo of the device
logo: sample-model.png
# ID(s) of the profile that defines the LoRaWAN characteristics of this model.
# id: as defined under /profiles.
# lorawanDeviceProfileID: as defined by LoRa Alliance in https://lora-alliance.org/wp-content/uploads/2020/10/LoRa_Alliance_Vendor_ID_for_QR_Code_02142022.pdf.
# The lorawanDeviceProfileID consists of 8 upper-case hexadecimal characters, 4 characters for VendorID + 4 characters for VendorProfileID. Please consider using single (') or double (") quotation.
deviceProfileIds:
- id: svendor_RFGroup1_1.0.2revB_classA
lorawanDeviceProfileID: '00010001'
- id: svendor_RFGroup2_1.0.2revB_classA
lorawanDeviceProfileID: '00010002'
# You may optionally customize any of the following settings to override the generic value set in LoRaWAN device profiles associated with your model. Leave empty if you want to keep the Device Profile settings.
# Maximum device TX Conducted output power in dBm.
maxTxPower:
# Minimum device TX Conducted output power in dBm.
minTxPower:
# Maximum device TX Radiated output power in dBm.
maxTxEIRP:
# Minimum device TX Radiated output power in dBm.
minTxEIRP:
# Typical mobility profile of the device. Possible values are 'near_static' (also valid for static devices), 'walking_speed', 'vehicular_speed'
# or 'random' (not known, changes over time).
motionIndicator:
# Is your device certified by the LoRa Alliance? Possible values: true, false.
LoRaWANCertified:
# Always mandatory: `<vendorId>:<modelName>:<modelVersion>` (You should have only one per model)
# Format: `<8 characters max>:<16 characters max>:<digits only>`
# Be careful: Once you chose a model, it cannot be changed later
modelId: svendor:sample-model:1
# <vendorId>:<protocolName>:<protocolVersion> Needed for linking the model with a specific driver -> must be the same one used in driver.yaml in the corresponding model (You might have several ones)
# Be careful: Once you chose a protocolId, it cannot be changed later
protocolId:
- svendor:sample-model-protocol:1
# DataSheet URL (optional)
specificationURL:
# User Guide URL (optional)
userGuideURL:
# <sensor>:<unitId> Available sensors following Actility ontology: https://github.com/actility/device-catalog/blob/main/template/sample-vendor/drivers/ONTOLOGY.md
sensors:
- temperature:Cel
- humidity:%RH
# Driver examples
# A list of examples description that are compatible with this model
examples:
svendor:sample-model-protocol:1:
- uplink containing only pulse counter
- uplink containing three measurements
- uplink containing only humidity
- uplink containing only temperature
- fail decode uplink containing only humidity with unknown id
- fail decode uplink containing only humidity with oob
- encode downlink containing only pulseCounterThreshold
- encode downlink containing only alarm
- encode downlink containing alarm and pulseCounterThreshold
- fail encode downlink when pulseCounterThreshold exceeds 255
- decode downlink containing only pulseCounterThreshold
- decode downlink containing only alarm
- decode downlink containing alarm and pulseCounterThreshold
- fail decode downlink when payload contains pulseCounterThreshold with oob
- fail decode downlink when payload contains alarm with oob
- fail decode downlink when unknown id