Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2752779
commit 3ae3ae5
Showing
3 changed files
with
176 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| --- | ||
| title: "Class B" | ||
| description: "" | ||
| --- | ||
|
|
||
| Class B end devices listen for downlink messages during ping slots. This allows applications to send messages to devices at predefined time slots, rather than waiting for a Class A uplink. When combined with [multicast groups]({{< ref "/devices/multicast" >}}), this allows applications to send periodic downlinks to many devices at the same time. | ||
|
|
||
| <!--more--> | ||
|
|
||
| ## Enabling and Disabling Class B | ||
|
|
||
| In order to send Class B downlink messages to a single device, enable Class B support for the end device when creating or updating it with the `--supports-class-b` flag. | ||
|
|
||
| For example, when enabling Class B for an existing device: | ||
|
|
||
| ```bash | ||
| $ ttn-lw-cli end-devices set app1 dev1 --supports-class-b | ||
| ``` | ||
|
|
||
| This will enable the Class B downlink scheduling of the device. Downlink messages are now scheduled during the next available ping slot. | ||
|
|
||
| To disable Class B scheduling, reset with `--supports-class-b=false`. | ||
|
|
||
| {{< note >}} For unicast devices, Class B downlink scheduling starts when the end device sends an uplink with the Class B bit set. This means that an OTAA device should send an uplink message with the Class B bit set after receiving the join-accept in order to enable Class B downlink scheduling. {{</ note >}} | ||
|
|
||
| ## Multicast Group | ||
|
|
||
| See [Multicast]({{< ref "devices/multicast" >}}) for instructions for creating and using multicast groups. | ||
|
|
||
| ## Class B Message Settings | ||
|
|
||
| {{% tts %}} supports optional settings for Class B downlink messages: the downlink path and the time to send the message. | ||
|
|
||
| The downlink path is defined by one or more gateways IDs. The Network Server and Gateway Server schedules only on the specified gateways in the specified order. This is useful for multicast (where no downlink path is known because there is no uplink). A scheduling attempt can fail when the gateway is not connected, if there is a scheduling conflict or if duty-cycle regulations prohibit transmission. | ||
|
|
||
| The time to transmit is an absolute timestamp in ISO 8601 format to send the message. This requires gateways either with GPS lock, or gateways that use a protocol that provide round-trip times (RTT). See the [Example]({{< relref "#example" >}}) section below. | ||
|
|
||
| ## Example | ||
|
|
||
| {{< cli-only >}} | ||
|
|
||
| First, create a Class B device: | ||
|
|
||
| ```bash | ||
| $ ttn-lw-cli end-devices create app1 dev1 \ | ||
| --frequency-plan-id EU_863_870 \ | ||
| --lorawan-version 1.0.3 \ | ||
| --lorawan-phy-version 1.0.3-a \ | ||
| --session.dev-addr 00E4304D \ | ||
| --session.keys.app-s-key.key A0CAD5A30036DBE03096EB67CA975BAA \ | ||
| --session.keys.nwk-s-key.key B7F3E161BC9D4388E6C788A0C547F255 \ | ||
| --supports-class-b | ||
| ``` | ||
|
|
||
| Then, schedule the following message to the [Application Server MQTT server]({{< ref "/integrations/mqtt" >}}) or [HTTP webhooks]({{< ref "/integrations/webhooks" >}}): | ||
|
|
||
| ```json | ||
| { | ||
| "downlinks": [{ | ||
| "frm_payload": "vu8=", | ||
| "f_port": 42, | ||
| "priority": "NORMAL", | ||
| "class_b_c": { | ||
| "gateways": [ | ||
| { | ||
| "gateway_ids": { | ||
| "gateway_id": "gtw1" | ||
| }, | ||
| }, | ||
| { | ||
| "gateway_ids": { | ||
| "gateway_id": "gtw2" | ||
| }, | ||
| } | ||
| ], | ||
| "absolute_time": "2019-07-23T13:05:00Z" | ||
| } | ||
| }] | ||
| } | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| --- | ||
| title: "Multicast" | ||
| description: "" | ||
| aliases: ["devices/class-c-multicast"] | ||
| --- | ||
|
|
||
| It is also possible to create a [Class B]({{< ref "devices/class-b" >}}) or [Class C]({{< ref "devices/class-c" >}}) multicast group to send downlink messages to a group of end devices. A multicast group is a virtual ABP device (i.e. shared session keys), does not support uplink, confirmed downlink nor MAC commands. | ||
|
|
||
| <!--more--> | ||
|
|
||
| ## Class B and Multicast | ||
|
|
||
| Since there are no uplinks in multicast groups, there is no MAC layer communication between the end device and {{% tts %}}. Therefore, it is necessary to specify the ping slot periodicity by setting the following parameter: | ||
|
|
||
| - `mac-settings.ping-slot-periodicity.value` | ||
|
|
||
| See the [MAC Settings]({{< ref "devices/mac-settings" >}}) guide for more information about configuring MAC layer parameters. | ||
|
|
||
| ## Creating a Multicast Group | ||
|
|
||
| When creating a device, you can specify in the Console and CLI whether it's a multicast group. | ||
|
|
||
| CLI example: | ||
|
|
||
| ```bash | ||
| $ ttn-lw-cli end-devices create app1 mc1 \ | ||
| --frequency-plan-id EU_863_870 \ | ||
| --lorawan-version 1.0.3 \ | ||
| --lorawan-phy-version 1.0.3-a \ | ||
| --session.dev-addr 00E4304D \ | ||
| --session.keys.app-s-key.key A0CAD5A30036DBE03096EB67CA975BAA \ | ||
| --session.keys.nwk-s-key.key B7F3E161BC9D4388E6C788A0C547F255 \ | ||
| --multicast \ | ||
| --supports-class-c # or --supports-class-b | ||
| ``` | ||
|
|
||
| {{< note >}} A multicast group cannot be converted to a normal unicast device or the other way around. {{</ note >}} | ||
|
|
||
| {{< note >}} Since multicast does not support uplink, the Network Server does not know a downlink path. Therefore, you need to specify a downlink path when scheduling downlink message. {{</ note >}} | ||
|
|
||
| ## Example | ||
|
|
||
| {{< cli-only >}} | ||
|
|
||
| First, create a multicast group: | ||
|
|
||
| ```bash | ||
| $ ttn-lw-cli end-devices create app1 mc1 \ | ||
| --frequency-plan-id EU_863_870 \ | ||
| --lorawan-version 1.0.3 \ | ||
| --lorawan-phy-version 1.0.3-a \ | ||
| --session.dev-addr 00E4304D \ | ||
| --session.keys.app-s-key.key A0CAD5A30036DBE03096EB67CA975BAA \ | ||
| --session.keys.nwk-s-key.key B7F3E161BC9D4388E6C788A0C547F255 \ | ||
| --multicast \ | ||
| --supports-class-c | ||
| ``` | ||
|
|
||
| Then, schedule the following message to the [Application Server MQTT server]({{< ref "/integrations/mqtt" >}}) or [HTTP webhooks]({{< ref "/integrations/webhooks" >}}). A downlink path must be specified because none is known, as there is no uplink in multicast: | ||
|
|
||
| ```json | ||
| { | ||
| "downlinks": [{ | ||
| "frm_payload": "vu8=", | ||
| "f_port": 42, | ||
| "priority": "NORMAL", | ||
| "class_b_c": { | ||
| "gateways": [ | ||
| { | ||
| "gateway_ids": { | ||
| "gateway_id": "gtw1" | ||
| }, | ||
| }, | ||
| { | ||
| "gateway_ids": { | ||
| "gateway_id": "gtw2" | ||
| }, | ||
| } | ||
| ], | ||
| "absolute_time": "2019-07-23T13:05:00Z" | ||
| } | ||
| }] | ||
| } | ||
| ``` | ||
|
|