Skip to content

Commit 6a9c265

Browse files
committed
samples: add new 'End to End IoT Tank Monitoring' sample
Signed-off-by: Diego Escalona <diego.escalona@digi.com>
1 parent 75e0b45 commit 6a9c265

File tree

2 files changed

+645
-0
lines changed

2 files changed

+645
-0
lines changed
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
End to End Tank Monitoring IoT Sample Application
2+
=================================================
3+
4+
This example is part of the Digi's End-to-End Tank Monitoring IoT demo. It
5+
demonstrates how to use the XBee 3 Cellular modules to communicate with Digi
6+
Remote Manager and use the BLE interface to talk to mobile apps applied to
7+
the tank monitoring vertical.
8+
9+
In theory, the XBee 3 Cellular module this example runs in corresponds to a
10+
tank controller and is connected to the following peripherals but, for
11+
demonstration purposes, they are emulated:
12+
* Level sensor.
13+
* Electronic valve.
14+
15+
The example performs the following actions:
16+
* Listen for BLE connections to execute the provisioning process (initial
17+
configuration of the tank controller properties).
18+
* Read the values of the sensors and upload them to Digi Remote Manager
19+
periodically.
20+
* Listen for requests coming from Digi Remote Manager and execute the proper
21+
actions.
22+
23+
Read the demo documentation for more information.
24+
25+
Requirements
26+
------------
27+
28+
To run this example you need:
29+
30+
* At least one XBee 3 Cellular module and its corresponding carrier board
31+
(XBIB-C board).
32+
* A smartphone running the corresponding mobile app of the demo.
33+
* A Digi Remote Manager account. Go to https://myaccount.digi.com/ to create it
34+
if you do not have one.
35+
36+
Setup
37+
-----
38+
39+
Make sure the hardware is set up correctly. For each XBee 3 Cellular module:
40+
41+
1. Plug the XBee 3 Cellular radio module into the XBee adapter and connect it
42+
to your computer's USB port.
43+
2. Make sure the XBee3 cellular device is connected to Internet. To do so,
44+
verify that the Connection status LED is blinking or the value of the
45+
**AI** parameter is **0**.
46+
3. Using XCTU, enable the *"Always remain connected to Digi Remote Manager
47+
through TCP"* feature by setting the **MO** parameter to **7**. This way The
48+
device remains connected to Digi Remote Manager while you test the sample.
49+
4. Make sure the XBee3 cellular device is connected to Digi Remote Manager. To
50+
do so, verify that the value of the **DI** parameter is **0**, **5** or
51+
**6**.
52+
53+
Run
54+
---
55+
56+
The example is already configured, so all you need to do is build and launch
57+
the project. Then, read the demo documentation for more information about how
58+
to test the demo.
59+
60+
Supported platforms
61+
-------------------
62+
63+
* Digi XBee3 Cellular LTE-M/NB-IoT - minimum firmware version: 11410
64+
* Digi XBee3 Cellular LTE Cat 1 - minimum firmware version: x10
65+
66+
License
67+
-------
68+
69+
Copyright (c) 2020, Digi International, Inc.
70+
71+
Permission is hereby granted, free of charge, to any person obtaining a copy
72+
of this software and associated documentation files (the "Software"), to deal
73+
in the Software without restriction, including without limitation the rights
74+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
75+
copies of the Software, and to permit persons to whom the Software is
76+
furnished to do so, subject to the following conditions:
77+
78+
The above copyright notice and this permission notice shall be included in all
79+
copies or substantial portions of the Software.
80+
81+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
82+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
83+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
84+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
85+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
86+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
87+
SOFTWARE.

0 commit comments

Comments
 (0)