Skip to content

Commit 41f49b8

Browse files
uibdevuibdev
committed
Email change in UIB-template documentation
2 parents 62ca8a8 + f471f28 commit 41f49b8

12 files changed

Lines changed: 3085 additions & 556 deletions

File tree

‎.github/workflows/issue-triage.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ name: Triage New Issues
22
on:
33
issues:
44
types: [opened]
5+
pull_request_target:
6+
types: [opened]
57

68
jobs:
79
triage:

‎doc/config/_default/config.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ pygmentsUseClasses = true
2222
github_repository = "https://github.com/TheThingsIndustries/lorawan-stack-docs"
2323
github_repository_edit = "https://github.com/TheThingsIndustries/lorawan-stack-docs/blob/master/doc/content"
2424
tts_github_repository = "https://github.com/TheThingsNetwork/lorawan-stack"
25-
version = "v3.12"
25+
version = "v3.13"
2626

2727
[markup]
2828
[markup.goldmark]

‎doc/content/integrations/cloud-integrations/dezem/_index.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: "deZem"
3+
description: "deZem IoT data management system"
4+
---
5+
6+
The [deZem IoT data management system](https://www.dezem.de/en/data-acquisition/lorawan/) facilitates an increased efficiency and productivity of plants, processes and infrastructure. To this end, deZem provides a modular solution to collect sensor data from very heterogeneous sources on a single platform, and a large variety of online analysis tools. As LoRaWAN devices are great for effortless data acquisition in the field, the deZem system integrates with {{% tts %}}.
7+
8+
![deZemAd TheThingsStack import interface](lorawan-and-dezem.svg)
9+
10+
## Prerequisites
11+
12+
1. deZem account
13+
2. User rights for deZemAd's technical tree
14+
15+
## Setup
16+
17+
In the technical tree of deZemAd, create a new device of type **LoRaWAN TTS interface**.
18+
19+
![deZemAd TTS import interface](dezem-ad-lorawan-import-interface.png)
20+
21+
Configure the same **API key** in deZemAd and in deZem's Webhook template.
22+
23+
![deZem Webhook Template](dezem-webhook-template.png)
24+
25+
## Analyze and Visualize
26+
27+
Create analyses and vizualisations for use in production.
28+
29+
![deZem dashboard](dezem-dashboard.jpg)

‎doc/content/integrations/cloud-integrations/dezem/dezem-ad-lorawan-import-interface.png‎

51.6 KB
Loading

‎doc/content/integrations/cloud-integrations/dezem/dezem-dashboard.jpg‎

102 KB
Loading

‎doc/content/integrations/cloud-integrations/dezem/dezem-webhook-template.png‎

81 KB
Loading

‎doc/content/integrations/cloud-integrations/dezem/lorawan-and-dezem.svg‎

Lines changed: 1002 additions & 0 deletions
Loading

‎doc/content/integrations/cloud-integrations/uib/_index.md‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,27 @@ weight:
55
aliases: []
66
---
77

8-
[UIB's](https://www.uib.ai/) technology makes human to machine communications simple.
8+
[UIB's](https://www.uib.ai/) technology makes human to machine communications simple. Keep following this guide to find out how to send notifications on data events to WhatsApp.
99

1010
<!--more-->
1111

1212
## Prerequisites
1313

14-
To send a message via WhatsApp, you need to have a WhatsApp Business Account and the content of the notification message which you need to send to the customer has to be submitted to WhatsApp and approved, before it can be used.
14+
1. A WhatsApp Business Account.
15+
2. The content of the notification message which you need to send to the customer has to be submitted and approved by WhatsApp, before it can be used.
1516

16-
Please send UIB an email to [support@uib.ai](mailto:support@uib.ai), with your company details, Facebook Business Manager ID and an approximate no. of messages you want to send per month. UIB's support team will revert back with the pricing and next steps.
17+
{{< info >}} Please send an email to [info@uib.ai](mailto:info@uib.ai) with your company details, Facebook Business Manager ID and an approximate number of messages you want to send per month. UIB's support team will respond you back with the pricing and the steps to proceed. {{</ info >}}
1718

18-
Please note that the template/notification name, name space, access key etc will be provided once the notification message content is approved by WhatsApp.
19+
{{< note >}} Please note that the template/notification name, name space, access key, etc. will be provided once the notification message content is approved by WhatsApp. {{</ note >}}
1920

2021

21-
## Configure {{% tts %}}
22+
## Define the Uplink Payload Formatter
23+
24+
In order for UIB to be able to decode the data coming from {{% tts %}}, you need to create an uplink [payload formatter]({{< ref "/integrations/payload-formatters" >}}) on {{% tts %}} to set fields in the `decoded_payload` object of the uplink message.
2225

23-
In order for UIB to be able to decode the data coming from {{% tts %}}, you need to create an uplink [payload formatter]({{< ref "/integrations/payload-formatters" >}}) on {{% tts %}} in order to decode the uplink payload and set fields in the `decoded_payload` object of the uplink message. The notification message will be sent to user if the `decoded_payload_warnings` is not empty. You can push a text to the warnings array according to your parameter thresholds (`field1`, `field2` etc can be the data of your device, like temperature or pressure). The example uplink payload formatter is shown below.
26+
The notification message will be sent to the user if the `decoded_payload_warnings` field is not empty. You can push a text to the warnings array according to your parameter thresholds (`field1`, `field2`, etc. can be the data of your device, for example temperature or pressure).
27+
28+
The example uplink payload formatter is shown below:
2429

2530
```js
2631
function decodeUplink(input) {
@@ -38,11 +43,15 @@ function decodeUplink(input) {
3843
}
3944
```
4045

41-
Next, you can create a Webhook integration by instantiating the **UIB** [Webhook template]({{< ref "/integrations/webhooks/webhook-templates" >}}).
46+
## Configure {{% tts %}}
47+
48+
Next, you need to create a Webhook integration by instantiating the **UIB** [Webhook template]({{< ref "/integrations/webhooks/webhook-templates" >}}).
49+
50+
The **Application Key**, **Template Name** and **Template Namespace** values are provided by UIB, and you need to use them in the respective fields of the UIB Webhook template.
51+
52+
The **Receiver Phone Number(s)**, to which the notification message is to be sent, need to be separated by comma on entry.
4253

43-
The **Application Key**, **Template Name** and the **Template Namespace** values will be provided by UIB and use them in the respective fields of the UIB template on {{% tts %}}.
44-
The **Receiver Phone Number(s)** to which the notification message has to be sent are to be entered separated by comma.
45-
The **Template Variables** should be added as comma separated and in the order as they appear in the notification message. Use the same parameter names as you provide in the payload formatter
54+
The **Template Variables** should also be comma separated, and in the order as they appear in the notification message. Make sure to use the same parameter names which you have provided in the payload formatter above.
4655

4756
{{< figure src="uib-template-webhook.png" alt="UIB webhook" >}}
4857

‎doc/content/whats-new/3.13.0.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
date: 2021-05-20
3+
title: "3.13.0"
4+
---
5+
6+
### Added
7+
8+
- Searching Packet Broker networks with `--tenant-id-contains` and `--name-contains` flags.
9+
- Listing all listed Packet Broker networks with `ttn-lw-cli packetbroker networks list`.
10+
- Include end device version identifiers in upstream messages (see `uplink_message.version_ids.brand_id`, `uplink_message.version_ids.model_id`, `uplink_message.version_ids.firmware_version`, `uplink_message.version_ids.hardware_version` and `uplink_message.version_ids.band_id` fields).
11+
- Reporting uplink and downlink message delivery state changes to Packet Broker. This will be used for statistical purposes (e.g. which message is processed successfully or why it errored) as well as LoRaWAN roaming (the `XmitDataAns` result code).
12+
- Setting API key expiry via `--api-key-expiry` flag using RFC3339 format.
13+
- Events storage in the Redis events backend. This can be enabled with the new `events.redis.store.enable` option. The new options `events.redis.store.ttl`, `events.redis.store.entity-ttl`, `events.redis.store.entity-count` and `events.redis.store.correlation-id-count` can be used to configure retention.
14+
- RPC to find related events by correlation ID.
15+
- CLI command `events find-related`.
16+
- Support for loading Device Repository profiles from different vendors if specified. This allows reusing standard end device profiles from module makers and LoRaWAN end device stack vendors.
17+
- Filtering out verbose events in the event views in the Console.
18+
- The `gs.up.forward` event now includes the host an uplink was forwarded to.
19+
- Previews for `*.update` events in the Console.
20+
- The Console can now show recent historical events in networks that have events storage enabled.
21+
22+
### Changed
23+
24+
- User IDs now have a minimum length of 2 instead of 3, so that more users coming from v2 can keep their username.
25+
- Disabled device uplink simulation and downlink message sending when skipping payload crypto.
26+
- The UpdateAPIKey RPCs now take a fieldmask.
27+
- The Gateway Server no longer sends `gs.up.drop` event if the Network Server does not handle an uplink message, or if the uplink does not match the DevAddr prefix of an upstream.
28+
- Maximum size for user-defined payload formatter scripts.
29+
- The default cap is at 4KB, see the new `as.formatters.max-parameter-length` config option.
30+
- A maximum cap of 16KB per script is set at the API level.
31+
- This only prevents setting large payload formatter scripts for new devices and applications; it does not remove payload formatters from existing applications and devices. Scripts sourced from the Device Repository are not affected. See [issue #4053](https://github.com/TheThingsNetwork/lorawan-stack/issues/4053) for more context on this change.
32+
33+
### Deprecated
34+
35+
### Removed
36+
37+
- The `gs.status.forward` event.
38+
39+
### Fixed
40+
41+
- OAuth token exchange for OAuth clients that use Basic auth.
42+
- The CLI now properly returns a non-zero exit status code on invalid commands.
43+
- Gateway connection requests with zero EUI are rejected.
44+
- End device payload formatter reset to `FORMATTER_NONE` in the Console.
45+
46+
### Security

0 commit comments

Comments
 (0)