You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-7
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,10 @@
1
-
# Prototype with Orange using Live Objects and Arduino MKR Boards
1
+
# Quickly prototype IoT solutions with Orange using Live Objects and Arduino compatible boards
2
2
3
-
### Discover Orange [**Live Objects**](https://liveobjects.orange-business.com)using dedicated SDK for [**Arduino MKR family boards**](https://store.arduino.cc/arduino-genuino/arduino-genuino-mkr-family).
3
+
### Discover [**Live Objects**](https://liveobjects.orange-business.com), the IoT platform from Orange using this dedicated SDK for [**Arduino**](https://store.arduino.cc/arduino-genuino/arduino-genuino-mkr-family) and compatible boards.
4
4
5
-
This code wraps all the functions necessary to make your object work with Live Objects.
5
+
This dedicated SDK simplifies connecting your MKR board to the Live Objects platform. It manages LTE-M, GSM, and WiFi connections (depending on your board) and handle MQTT(S) and SMS communication behind the scenes. Easily define parameters you can update remotely and create commands to trigger actions on your device.
6
6
7
-
You can declare parameters, which you can later update OTA from Live objects. You can also create commands to trigger actions remotely.
8
-
9
-
The code will manage the LTE-M, GSM and WiFi connection (depending on currently used board), as well MQTT(S) and SMS exchanges with Live objects under the hood to keep your parameters up to date or execute the commands received without you having to take care of them (apart from writing the code of these commands, of course).
7
+
Focus on your application logic – this library handles the communication with the Live Objects platform, keeping your parameters synchronized and executing received commands.
10
8
11
9
## Compatibility ##
12
10
| Board | MQTT | MQTTS | SMS |
@@ -37,6 +35,7 @@ This code needs external libraries to run, that you can install using the built-
37
35
38
36
#### Library developed by Benoît Blanchon (mandatory for both Arduino, ESP and Adafruit boards)
39
37
-[ArduinoJson](https://arduinojson.org/), a powerful library used to parse, store and handle JSON easily
38
+
The default installation includes ArduinoJSON v6.21.5, optimized for the architectures supported by this SDK. While later versions of ArduinoJSON are compatible, they will consume more flash memory (see [here](https://arduinojson.org/news/2024/01/03/arduinojson-7/)).
40
39
41
40
#### SAMD21 Arduino core
42
41
- You also need to install the Arduino core for Atmel SAMD21 processor, used on the boards of the MKR family. Open the [Boards Manager](https://www.arduino.cc/en/guide/cores) and install the package called "Arduino SAMD Boards (32-bit ARM Cortex-M0+)".
@@ -47,7 +46,7 @@ This code needs external libraries to run, that you can install using the built-
47
46
2. Create an [API key](https://liveobjects.orange-business.com/#/administration/apikeys) for your device. Give it a name, select the *Device access* role and validate. Copy the key.
48
47
3. Clone or download the directory from Github.
49
48
4. In the **'src/arduino_secrets.h'** file :
50
-
- Paste it as initialization value for the `SECRET_LIVEOBJECTS_API_KEY` variable in the 'arduino_secrets.h' file -keep the double quotes!
49
+
- Paste it as initialization value for the `SECRET_LIVEOBJECTS_API_KEY` variable in the 'arduino_secrets.h' file — keep the double quotes!
51
50
52
51
- In case of feather 32u4 you have to change type of this variable to *char** from *String*.
53
52
- Fill in the connection(WIFI or GSM) credentials if needed (pin code, APN information, etc). In case of GSM connection, most of the time, APN will set up automatically. Your SIM card may have a default pin code (like "0000"), unless you deactivated it using the [Pin management](https://github.com/arduino-libraries/MKRNB/blob/master/examples/Tools/PinManagement/PinManagement.ino) sketch, provided with the MKRNB library.
maintainer=Marc Delain <marc.delain@orange.com>, Krzysztof Krzeslak <krzysztof.krzeslak@orange.com>, Tomasz Malek <tomasz.malek@orange.com>
5
-
sentence=A library that makes connection with Orange LiveObjects platform a breeze.
6
-
paragraph=Supports connection with LiveObjects platform in device mode, with the use of LTE, GSM or WifI connectivity.
5
+
sentence=A library that simplifies the integration of Arduino boards with Live Objects, the IoT platform from Orange.
6
+
paragraph=Upgrade your Arduino projects to IoT with this library, which allows you to easily connect your board to the Live Objects platform: send data, remotely modify execution parameters, or send commands to interact with your board.
0 commit comments