Skip to content

Commit ef178ee

Browse files
halimihalimi
committed
api: Comment mutual exclusivity of MAC settings and MAC settings profile
1 parent 2da3245 commit ef178ee

File tree

5 files changed

+20
-16
lines changed

5 files changed

+20
-16
lines changed

‎api/ttn/lorawan/v3/api.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4022,7 +4022,7 @@ SDKs are responsible for combining (if desired) the three.
40224022
| `resets_join_nonces` | [`bool`](#bool) | | Whether the device resets the join and dev nonces (not LoRaWAN compliant). Stored in Join Server. Copied on creation from template identified by version_ids, if any or from the home Network Server device profile, if any. |
40234023
| `root_keys` | [`RootKeys`](#ttn.lorawan.v3.RootKeys) | | Device root keys. Stored in Join Server. |
40244024
| `net_id` | [`bytes`](#bytes) | | Home NetID. Stored in Join Server. |
4025-
| `mac_settings` | [`MACSettings`](#ttn.lorawan.v3.MACSettings) | | Settings for how the Network Server handles MAC layer for this device. Stored in Network Server. |
4025+
| `mac_settings` | [`MACSettings`](#ttn.lorawan.v3.MACSettings) | | Settings for how the Network Server handles MAC layer for this device. Stored in Network Server. Mutually exclusive with MAC settings profile. |
40264026
| `mac_state` | [`MACState`](#ttn.lorawan.v3.MACState) | | MAC state of the device. Stored in Network Server. |
40274027
| `pending_mac_state` | [`MACState`](#ttn.lorawan.v3.MACState) | | Pending MAC state of the device. Stored in Network Server. |
40284028
| `session` | [`Session`](#ttn.lorawan.v3.Session) | | Current session of the device. Stored in Network Server and Application Server. |
@@ -4048,7 +4048,7 @@ SDKs are responsible for combining (if desired) the three.
40484048
| `last_seen_at` | [`google.protobuf.Timestamp`](#google.protobuf.Timestamp) | | Timestamp when a device uplink has been last observed. This field is set by the Application Server and stored in the Identity Server. |
40494049
| `serial_number` | [`string`](#string) | | |
40504050
| `lora_alliance_profile_ids` | [`LoRaAllianceProfileIdentifiers`](#ttn.lorawan.v3.LoRaAllianceProfileIdentifiers) | | |
4051-
| `mac_settings_profile_ids` | [`MACSettingsProfileIdentifiers`](#ttn.lorawan.v3.MACSettingsProfileIdentifiers) | | MAC settings profile identifiers. |
4051+
| `mac_settings_profile_ids` | [`MACSettingsProfileIdentifiers`](#ttn.lorawan.v3.MACSettingsProfileIdentifiers) | | MAC settings profile identifiers. Mutually exclusive with MAC settings. |
40524052

40534053
#### Field Rules
40544054

‎api/ttn/lorawan/v3/api.swagger.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21837,7 +21837,7 @@
2183721837
},
2183821838
"mac_settings": {
2183921839
"$ref": "#/definitions/v3MACSettings",
21840-
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server."
21840+
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server.\nMutually exclusive with MAC settings profile."
2184121841
},
2184221842
"mac_state": {
2184321843
"$ref": "#/definitions/v3MACState",
@@ -21956,7 +21956,7 @@
2195621956
},
2195721957
"mac_settings_profile_ids": {
2195821958
"$ref": "#/definitions/v3MACSettingsProfileIdentifiers",
21959-
"description": "MAC settings profile identifiers."
21959+
"description": "MAC settings profile identifiers.\nMutually exclusive with MAC settings."
2196021960
}
2196121961
},
2196221962
"description": "Defines an End Device registration and its state on the network.\nThe persistence of the EndDevice is divided between the Network Server, Application Server and Join Server.\nSDKs are responsible for combining (if desired) the three."
@@ -23276,7 +23276,7 @@
2327623276
},
2327723277
"mac_settings": {
2327823278
"$ref": "#/definitions/v3MACSettings",
23279-
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server."
23279+
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server.\nMutually exclusive with MAC settings profile."
2328023280
},
2328123281
"mac_state": {
2328223282
"$ref": "#/definitions/v3MACState",
@@ -23395,7 +23395,7 @@
2339523395
},
2339623396
"mac_settings_profile_ids": {
2339723397
"$ref": "#/definitions/v3MACSettingsProfileIdentifiers",
23398-
"description": "MAC settings profile identifiers."
23398+
"description": "MAC settings profile identifiers.\nMutually exclusive with MAC settings."
2339923399
}
2340023400
},
2340123401
"description": "Defines an End Device registration and its state on the network.\nThe persistence of the EndDevice is divided between the Network Server, Application Server and Join Server.\nSDKs are responsible for combining (if desired) the three."
@@ -23760,7 +23760,7 @@
2376023760
},
2376123761
"mac_settings": {
2376223762
"$ref": "#/definitions/v3MACSettings",
23763-
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server."
23763+
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server.\nMutually exclusive with MAC settings profile."
2376423764
},
2376523765
"mac_state": {
2376623766
"$ref": "#/definitions/v3MACState",
@@ -23879,7 +23879,7 @@
2387923879
},
2388023880
"mac_settings_profile_ids": {
2388123881
"$ref": "#/definitions/v3MACSettingsProfileIdentifiers",
23882-
"description": "MAC settings profile identifiers."
23882+
"description": "MAC settings profile identifiers.\nMutually exclusive with MAC settings."
2388323883
}
2388423884
},
2388523885
"description": "Defines an End Device registration and its state on the network.\nThe persistence of the EndDevice is divided between the Network Server, Application Server and Join Server.\nSDKs are responsible for combining (if desired) the three."
@@ -24067,7 +24067,7 @@
2406724067
},
2406824068
"mac_settings": {
2406924069
"$ref": "#/definitions/v3MACSettings",
24070-
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server."
24070+
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server.\nMutually exclusive with MAC settings profile."
2407124071
},
2407224072
"mac_state": {
2407324073
"$ref": "#/definitions/v3MACState",
@@ -24186,7 +24186,7 @@
2418624186
},
2418724187
"mac_settings_profile_ids": {
2418824188
"$ref": "#/definitions/v3MACSettingsProfileIdentifiers",
24189-
"description": "MAC settings profile identifiers."
24189+
"description": "MAC settings profile identifiers.\nMutually exclusive with MAC settings."
2419024190
}
2419124191
},
2419224192
"description": "Defines an End Device registration and its state on the network.\nThe persistence of the EndDevice is divided between the Network Server, Application Server and Join Server.\nSDKs are responsible for combining (if desired) the three."
@@ -25762,7 +25762,7 @@
2576225762
},
2576325763
"mac_settings": {
2576425764
"$ref": "#/definitions/v3MACSettings",
25765-
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server."
25765+
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server.\nMutually exclusive with MAC settings profile."
2576625766
},
2576725767
"mac_state": {
2576825768
"$ref": "#/definitions/v3MACState",
@@ -25881,7 +25881,7 @@
2588125881
},
2588225882
"mac_settings_profile_ids": {
2588325883
"$ref": "#/definitions/v3MACSettingsProfileIdentifiers",
25884-
"description": "MAC settings profile identifiers."
25884+
"description": "MAC settings profile identifiers.\nMutually exclusive with MAC settings."
2588525885
}
2588625886
},
2588725887
"description": "Defines an End Device registration and its state on the network.\nThe persistence of the EndDevice is divided between the Network Server, Application Server and Join Server.\nSDKs are responsible for combining (if desired) the three."
@@ -27795,7 +27795,7 @@
2779527795
},
2779627796
"mac_settings": {
2779727797
"$ref": "#/definitions/v3MACSettings",
27798-
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server."
27798+
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server.\nMutually exclusive with MAC settings profile."
2779927799
},
2780027800
"mac_state": {
2780127801
"$ref": "#/definitions/v3MACState",
@@ -27914,7 +27914,7 @@
2791427914
},
2791527915
"mac_settings_profile_ids": {
2791627916
"$ref": "#/definitions/v3MACSettingsProfileIdentifiers",
27917-
"description": "MAC settings profile identifiers."
27917+
"description": "MAC settings profile identifiers.\nMutually exclusive with MAC settings."
2791827918
}
2791927919
},
2792027920
"description": "Defines an End Device registration and its state on the network.\nThe persistence of the EndDevice is divided between the Network Server, Application Server and Join Server.\nSDKs are responsible for combining (if desired) the three."

‎api/ttn/lorawan/v3/end_device.proto‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1101,6 +1101,7 @@ message EndDevice {
11011101
}
11021102
];
11031103
// Settings for how the Network Server handles MAC layer for this device. Stored in Network Server.
1104+
// Mutually exclusive with MAC settings profile.
11041105
MACSettings mac_settings = 24;
11051106
// MAC state of the device. Stored in Network Server.
11061107
MACState mac_state = 25;
@@ -1212,6 +1213,7 @@ message EndDevice {
12121213
reserved "label_ids";
12131214

12141215
// MAC settings profile identifiers.
1216+
// Mutually exclusive with MAC settings.
12151217
MACSettingsProfileIdentifiers mac_settings_profile_ids = 58;
12161218

12171219
// next: 59;

‎pkg/ttnpb/end_device.pb.go‎

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎sdk/js/generated/api.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16447,7 +16447,7 @@
1644716447
},
1644816448
{
1644916449
"name": "mac_settings",
16450-
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server.",
16450+
"description": "Settings for how the Network Server handles MAC layer for this device. Stored in Network Server.\nMutually exclusive with MAC settings profile.",
1645116451
"label": "",
1645216452
"type": "MACSettings",
1645316453
"longType": "MACSettings",
@@ -16803,7 +16803,7 @@
1680316803
},
1680416804
{
1680516805
"name": "mac_settings_profile_ids",
16806-
"description": "MAC settings profile identifiers.",
16806+
"description": "MAC settings profile identifiers.\nMutually exclusive with MAC settings.",
1680716807
"label": "",
1680816808
"type": "MACSettingsProfileIdentifiers",
1680916809
"longType": "MACSettingsProfileIdentifiers",

0 commit comments

Comments
 (0)