blueprint freertos

1NCE FreeRTOS BluePrint

1NCE FreeRTOS BluePrint démontre l'utilisation de divers protocoles IoT, notamment CoAP, LwM2M et UDP avec connectivité cellulaire. Ce référentiel présente des exemples intégrant le SDK 1NCE pour exploiter les outils du système d'exploitation 1NCE, tels que l'authentification des appareils et les fonctionnalités d'économie d'énergie, à l'aide de la (bibliothèque Wakaama LWM2M).

Aperçu

Ce référentiel fournit des exemples des protocoles suivants :

• UDP
• CoAP (avec/sans DTLS)
• LwM2M avec Bootstrap (avec/sans DTLS)

Chaque démo comprend une fonctionnalité facultative d'économie d'énergie qui peut être activée à des fins de test.

Guide de démarrage rapide

Le dossier Binaries contient des binaires prédéfinis pour les applications de démonstration UDP et CoAP.

1. Configurer la fonctionnalité d'économie d'énergie dans 1NCE OS
   Utilisation de ce modèle.

2. Connectez la carte P-L496G-CELL02
   Lorsqu'elle est connectée via USB, la carte doit apparaître comme un lecteur de stockage sur votre ordinateur.

3. Flasher le binaire
   Faites simplement glisser et déposez le fichier binaire souhaité du dossier Binaries sur le lecteur de stockage. La carte fera automatiquement clignoter le binaire.

   Remarque : Si le clignotement échoue, reportez-vous à Clignotement à l'aide de STM32CubeProgrammer.

4. Afficher les journaux de démonstration
   Utilisez Serial Monitor dans Visual Studio Code pour afficher les journaux de démonstration.

Mise en route (version locale)

Conditions préalables

• Pack cellulaire vers cloud LTE P-L496G-CELL02 avec microcontrôleur STM32L496AG
• Carte SIM 1NCE
• VSCode
• Extension de code STM32 VS v2.0.0 avec les prérequis mentionnés.
• Assurez-vous que CMake version 3.22 ou supérieure est utilisée.

Mise à niveau du micrologiciel STLink

Une mise à niveau du micrologiciel STLink est requise. Le plugin STM32 VSCode inclut un bouton pour cela, mais si cela ne fonctionne pas, la mise à niveau peut être lancée manuellement en exécutant le fichier .bat à partir du dossier STM32 installé : ST/STM32CubeCLTxx/STLinUpgrade.bat

Mise à jour du micrologiciel du modem (facultatif)

Veuillez vous assurer que votre modem BG96 dispose de la dernière version du micrologiciel. Vous pouvez télécharger le package de mise à jour du micrologiciel et les instructions à partir de (page X-Cube Cellular de ST) (v6.0.0 recommandée).

Pour le flashage du modem, l'outil QFlash peut désormais être téléchargé depuis le site officiel de Quectel : (Téléchargement QFlash (V7.1))

Échantillon de bâtiment

Pour configurer la démo que vous souhaitez utiliser, modifiez le fichier nce_demo_config.h situé dans Application/Config/ : (par défaut CONFIG_COAP_DEMO_ENABLED )

 CONFIG_COAP_DEMO_ENABLED
CONFIG_UDP_DEMO_ENABLED
CONFIG_LwM2M_DEMO_ENABLED

Démos disponibles

Démo UDP

1NCE FreeRTOS BluePrint permet aux clients de communiquer avec les points de terminaison 1NCE via UDP et d'utiliser toutes les fonctionnalités du système d'exploitation 1NCE.

• Configurez le programme d'exécution de démonstration dans le fichier Application/Config/nce_demo_config.h

 #define CONFIG_UDP_DEMO_ENABLED

• Les paramètres suivants peuvent être configurés :

 #define CONFIG_UDP_DATA_UPLOAD_FREQUENCY_SECONDS    60

Démo COAP sans DTLS

1NCE FreeRTOS BluePrint permet aux clients de communiquer avec les points de terminaison 1NCE via CoAP et d'utiliser toutes les fonctionnalités dans le cadre du système d'exploitation 1NCE.

Requête COAP POST : Dans cette section, les étapes suivantes sont exécutées :

• Inscrivez-vous au réseau.

• Effectuez une résolution DNS.

• Créez un socket et connectez-vous au serveur

• Créer un POST CoAP confirmable avec l'option de requête

• Créer une interaction client et analyser la réponse (ACK)

• Validez la réponse.

• Configurez le programme d'exécution de démonstration dans le fichier Application/Config/nce_demo_config.h

 #define CONFIG_COAP_DEMO_ENABLED

• Les paramètres suivants peuvent être configurés :

    #define CONFIG_COAP_URI_QUERY                        "t=test"
    #define CONFIG_COAP_DATA_UPLOAD_FREQUENCY_SECONDS    60
    #define CONFIG_NCE_ENERGY_SAVER 

CoAP avec DTLS

Pour la prise en charge DTLS, le port par défaut est 5684 et définit automatiquement ENABLE_DTLS comme définition supplémentaire.

Le CoAP DTLS effectue 3 tâches principales à partir du SDK 1NCE IoT C :

• Envoyer la demande d'authentification de périphérique
• Obtenez la réponse
• Traitez la réponse et donnez l'identité DTLS et le PSK au code de l'application.

Démo LwM2M

Le support LWM2M est fourni à l'aide de la bibliothèque Eclipse Wakaama communiquant avec un serveur Leshan LWM2M. Ce mode permet à l'appareil d'agir en tant que client LwM2M, facilitant la communication avec un serveur LwM2M pour des cas d'utilisation tels que la gestion des appareils, les mises à jour du micrologiciel et la collecte de données de capteurs. Par défaut, le client s'enregistre auprès du serveur 1NCE LwM2M et une communication sécurisée est assurée via la prise en charge DTLS en option.

• Configurez le programme d'exécution de démonstration dans le fichier (Application/Config/nce_demo_config.h)

 #define CONFIG_LwM2M_DEMO_ENABLED 

Paramètres de configuration clés de LwM2M

Les paramètres suivants sont essentiels pour activer et personnaliser le mode client LwM2M dans le Blueprint :

• Point de terminaison du serveur LwM2M : l'appareil communique par défaut avec le serveur 1NCE LwM2M.

 #define LWM2M_ENDPOINT "lwm2m.os.1nce.com"

• Mode client LwM2M : il agira comme un client qui s'enregistre et communique avec un serveur LwM2M. Le mode client est responsable de l'envoi des requêtes (par exemple, les données de l'appareil ou les lectures des capteurs) au serveur et du traitement des commandes envoyées par le serveur.

 #define LWM2M_CLIENT_MODE

• Mode Bootstrap : permet à l'appareil de récupérer sa configuration, ses clés de sécurité et ses informations sur le serveur à partir d'un serveur d'amorçage si nécessaire. Cette fonctionnalité est utile lorsque l'appareil ne dispose pas de la configuration nécessaire pour s'enregistrer directement auprès du serveur LwM2M.

 #define LWM2M_BOOTSTRAP

• Prise en charge SenML JSON : cela permet à l'appareil d'envoyer les données du capteur au format JSON SenML (Sensor Markup Language). SenML est un moyen standardisé de représenter les mesures des capteurs et les événements des appareils au format JSON, ce qui facilite leur interprétation et leur traitement côté serveur.

 #define LWM2M_SUPPORT_SENML_JSON

• Format de données JSON : cela permet le formatage JSON pour la communication générale des données, garantissant ainsi la compatibilité avec les serveurs qui utilisent JSON pour envoyer et recevoir des messages.

 #define LWM2M_SUPPORT_JSON

• Format Little Endian : configure l'appareil pour utiliser l'ordre des octets Little Endian. Ceci est courant pour de nombreux systèmes embarqués et microcontrôleurs, où l'octet de poids faible est stocké ou transmis en premier.

 #define LWM2M_LITTLE_ENDIAN

• Prise en charge TLV (Type-Length-Value) : permet à l'appareil d'utiliser le codage TLV (Type-Length-Value), qui est un format binaire compact utilisé pour représenter des objets et des valeurs dans la communication LwM2M. TLV est particulièrement utile pour transférer efficacement des données entre des appareils contraints et le serveur.

 #define LWM2M_SUPPORT_TLV

• Taille de bloc par défaut CoAP : définit la taille de bloc par défaut sur 1 024 octets pour la communication CoAP. Lors du transfert de messages volumineux, des transferts par blocs sont utilisés et cette configuration détermine la taille de chaque bloc.

 #define LWM2M_COAP_DEFAULT_BLOCK_SIZE 1024

• Enregistrement sur un seul serveur : cette configuration garantit que l'appareil s'enregistre auprès d'un seul serveur LwM2M. Dans la plupart des cas, l'enregistrement sur plusieurs serveurs n'est pas nécessaire et un seul serveur suffit pour la gestion des appareils et l'échange de données.

 #define LWM2M_SINGLE_SERVER_REGISTERATION

• Envoi d'objet LwM2M : ceci définit l'URI de l'objet LwM2M qui sera envoyé au serveur. L'URI par défaut « /3/0 » correspond à l'objet périphérique LwM2M, qui fournit des informations essentielles sur le périphérique, telles que le fabricant, le numéro de modèle et la version du micrologiciel.

 #define LWM2M_OBJECT_SEND "/3/0"

• Veuillez ajouter l'ICCID dans le fichier de configuration. Si DTLS est activé, le psk d'amorçage doit également être défini. Le PSK peut être défini lors des tests d'intégration LwM2M via Device Integrator ou via l'API 1NCE.

    #define CONFIG_NCE_ICCID          ""
    #define CONFIG_LWM2M_BOOTSTRAP_PSK    ""

Fonction d'économie d'énergie

La fonctionnalité Energy Saver est disponible pour les démos UDP et CoAP. Il permet aux utilisateurs d'optimiser la consommation électrique des appareils lors de la communication avec les points de terminaison 1NCE.

Configuration

Pour activer la fonctionnalité Energy Saver, ajoutez l'indicateur suivant dans nce_demo_config.h :

 #define CONFIG_NCE_ENERGY_SAVER

Remarque : Pour utiliser la fonctionnalité d'économie d'énergie pour les démos UDP et CoAP, assurez-vous que le modèle de traduction correct est appliqué dans le système d'exploitation 1NCE. et le bon protocole sélectionné et le modèle utilisé.

Contrôleur de périphérique

Le Device Controller est une API qui vous permet d'interagir avec les appareils intégrés à l'API 1NCE. Vous pouvez utiliser cette API pour envoyer des requêtes aux appareils, et les appareils répondront en conséquence. Pour plus de détails, vous pouvez visiter notre DevHub

Envoi d'une demande

Pour envoyer une requête à un appareil spécifique, vous pouvez vous référer à notre documentation dans 1NCE DevHub

Configuration RTOS gratuite

Pour gérer la requête entrante de l'API 1NCE, la configuration de certains paramètres est nécessaire Application/Config/nce_demo_config.h

 /* C2D Parameters */
/* This port is used for both UDP and CoAP communication. */
#define NCE_RECV_PORT 3000
#define NCE_RECEIVE_BUFFER_SIZE_BYTES 200

• NCE_RECV_PORT : Il s'agit du numéro de port sur lequel votre appareil écoutera les demandes entrantes. Il doit correspondre au paramètre de port utilisé dans la requête.
• NCE_RECEIVE_BUFFER_SIZE_BYTES : C'est la taille du buffer qui sera utilisé pour recevoir les données entrantes de l'API 1NCE.

Remarque : C2D (Cloud to Device) est pris en charge pour les trois protocoles : UDP, CoAP et LwM2M. Le client LwM2M est étroitement intégré aux requêtes C2D et, pour UDP et CoAP, ouvre également un port en arrière-plan pour la communication C2D.

Dépannage

Micrologiciel du modem et configuration de la bande

Si l'appareil se connecte uniquement aux réseaux 2G ou ne parvient pas à se connecter dans certaines régions, vous devrez peut-être ajuster les paramètres de RAT (Radio Access Technology) et de bande dans Application/Config/nce_demo_config.h :

 #define CELLULAR_CONFIG_DEFAULT_RAT 8  // Example for CAT M1
#define CELLULAR_CONFIG_DEFAULT_RAT_2 0 // Example for GSM
#define CELLULAR_CONFIG_DEFAULT_RAT_3 9 // Example for NBIOT
#define CUSTOM_BAND_BG96 "AT+QCFG="band",F,80004,80008"  // Example for Germany CATM1

// Values 
/**
*  The GSM RATs network      0
*  The CAT M1 RATs network   8
*  The NBIOT RATs network    9
**/

Pour plus de détails sur les paramètres de bande, reportez-vous au manuel des commandes BG96 AT.

Clignotant à l'aide de STM32CubeProgrammer

• Téléchargez et installez STM32CubeProgrammer.
• Connectez la carte et appuyez sur « Connecter » pour activer ST-Link.
• Sélectionnez l'onglet "Effacement et programmation" sur la gauche.
• Ajoutez le fichier binaire et appuyez sur "Démarrer la programmation".

Configuration du niveau de journalisation

La verbosité des journaux peut être définie en définissant la macro LIBRARY_LOG_LEVEL dans le fichier Core/Inc/iot_config.h . Ce paramètre contrôle le niveau de détails de journalisation à des fins de débogage et de dépannage.

Les niveaux de journalisation disponibles pour LIBRARY_LOG_LEVEL sont :

IOT_LOG_NONE : désactive toute la journalisation. IOT_LOG_ERROR : active uniquement les messages d'erreur. IOT_LOG_WARN : Active les avertissements et les erreurs. IOT_LOG_INFO : active les messages d'information, les avertissements et les erreurs. IOT_LOG_DEBUG : active des informations de débogage détaillées, des avertissements, des erreurs et des messages d'information.

Exemple de configuration dans iot_config.h :

 #define LIBRARY_LOG_LEVEL IOT_LOG_DEBUG

Cette configuration génère toutes les informations de débogage, utiles lors du développement ou du dépannage.

Demander de l'aide

La communication la plus efficace avec notre équipe se fait via GitHub. Créez simplement un nouveau problème et sélectionnez parmi une gamme de modèles couvrant les rapports de bogues, les demandes de fonctionnalités, les problèmes de documentation ou les questions générales.