Oktatóanyag: ESPRESSIF ESP32-Azure IoT-készlet csatlakoztatása az IoT Hubhoz

Cikk
06/11/2024

Ebben az oktatóanyagban a FreeRTOS-hez készült Azure IoT köztes szoftver használatával csatlakoztatja az ESPRESSIF ESP32-Azure IoT Kitet (mostantól az ESP32 DevKitet) az Azure IoT-hez.

A következő feladatokat hajtja végre:

Beágyazott fejlesztői eszközök telepítése ESP32 DevKit programozásához
Kép létrehozása és villogása az ESP32 DevKitre
Az Azure CLI használatával létrehozhat és kezelhet egy Azure IoT Hubot, amelyhez az ESP32 DevKit csatlakozik
Az Azure IoT Explorer használatával regisztrálhat egy eszközt az IoT Hubon, megtekintheti az eszköz tulajdonságait, megtekintheti az eszköz telemetriáját, és közvetlen parancsokat hívhat meg az eszközön

Előfeltételek

Windows 10-et vagy Windows 11-et futtató számítógép
Git az adattár klónozásához
Hardver
- ESPRESSIF ESP32-Azure IoT Kit
- USB 2.0 A férfi és a Micro USB férfi kábel
- Wi-Fi 2,4 GHz
Aktív Azure-előfizetés. Ha még nincs Azure-előfizetése, kezdés előtt hozzon létre egy ingyenes fiókot.

A fejlesztési környezet előkészítése

Az eszközök telepítése

A fejlesztési környezet beállításához először telepítse az ESPRESSIF ESP-IDF buildkörnyezetet. A telepítő tartalmazza az eszköz klónozásához, összeállításához, villogásához és monitorozásához szükséges összes eszközt.

Az ESP-IDF-eszközök telepítése:

Töltse le és indítsa el az ESP-IDF v5.0 offline-installert.
Amikor a telepítő felsorolja a telepíteni kívánt összetevőket, jelölje ki az összes összetevőt, és fejezze be a telepítést.

Az adattár klónozása

Klónozza az alábbi adattárat az összes eszközkód, beállítási szkript és SDK-dokumentáció letöltéséhez. Ha korábban klónozta ezt az adattárat, nem kell újra elvégeznie.

Az adattár klónozásához futtassa a következő parancsot:

git clone --recursive  https://github.com/Azure-Samples/iot-middleware-freertos-samples.git

Windows 10 és 11 esetén győződjön meg arról, hogy a hosszú útvonalak engedélyezve vannak.

A hosszú útvonalak engedélyezéséről a Hosszú útvonalak engedélyezése a Windows 10-ben című témakörben olvashat.
A Gitben futtassa a következő parancsot egy rendszergazdai engedélyekkel rendelkező terminálban:
```
git config --system core.longpaths true
```

A felhőösszetevők létrehozása

IoT Hub létrehozása

Az Azure CLI használatával létrehozhat egy IoT Hubot, amely kezeli az eszköz eseményeit és üzenetkezelését.

IoT Hub létrehozása:

Indítsa el a CLI-alkalmazást. A parancssori felület parancsainak a rövid útmutató további részében való futtatásához másolja ki a parancs szintaxisát, illessze be a PARANCSSOR-alkalmazásba, szerkessze a változóértékeket, és nyomja le az Enter billentyűt.
- Ha Cloud Shellt használ, kattintson a jobb gombbal a Cloud Shell hivatkozására, és válassza ki azt a lehetőséget, hogy megnyíljon egy új lapon.
- Ha helyileg használja az Azure CLI-t, indítsa el a CLI-konzolalkalmazást, és jelentkezzen be az Azure CLI-be.
Futtassa az az extension add parancsot az azure-iot bővítmény telepítéséhez vagy frissítéséhez az aktuális verzióra.
```
az extension add --upgrade --name azure-iot
```
Futtassa az az group create parancsot egy erőforráscsoport létrehozásához. A következő parancs létrehoz egy MyResourceGroup nevű erőforráscsoportot a centralus régióban.

Feljegyzés

Igény szerint másikat is beállíthat location. Az elérhető helyek megtekintéséhez futtassa az az account list-locations parancsot.
```
az group create --name MyResourceGroup --location centralus
```
Futtassa az az iot hub create parancsot egy IoT Hub létrehozásához. Az IoT Hub létrehozása eltarthat néhány percig.

YourIotHubName. Cserélje le ezt a helyőrzőt a kódban az IoT Hubhoz választott névre. Az IoT Hub nevének globálisan egyedinek kell lennie az Azure-ban. Ez a helyőrző a rövid útmutató többi részében az egyedi IoT Hub-nevet jelöli.

A --sku F1 paraméter létrehozza az IoT Hubot az ingyenes szinten. Az ingyenes szintű központok korlátozott funkciókészlettel rendelkeznek, és a koncepcióalkalmazások ellenőrzésére szolgálnak. Az IoT Hub szintjeiről, funkcióiról és díjszabásáról további információt az Azure IoT Hub díjszabásában talál.
```
az iot hub create --resource-group MyResourceGroup --name {YourIoTHubName} --sku F1 --partition-count 2
```
Az IoT Hub létrehozása után tekintse meg a konzol JSON-kimenetét, és másolja a hostName használni kívánt értéket egy későbbi lépésben. Az hostName érték a következő példához hasonlóan néz ki:

{Your IoT hub name}.azure-devices.net

Az IoT Explorer konfigurálása

A rövid útmutató további részében az IoT Explorer használatával regisztrálhat egy eszközt az IoT Hubon, megtekintheti az eszköz tulajdonságait és telemetriáját, és parancsokat küldhet az eszköznek. Ebben a szakaszban úgy konfigurálja az IoT Explorert, hogy csatlakozzon a létrehozott IoT Hubhoz, és hogy beolvassa a plug and play modelleket a nyilvános modell adattárából.

Kapcsolat hozzáadása az IoT Hubhoz:

Telepítse az Azure IoT Explorert. Ez az eszköz egy platformfüggetlen segédprogram az Azure IoT-erőforrások monitorozásához és kezeléséhez.
A CLI-alkalmazásban futtassa az az iot hub connection-string show parancsot az IoT Hub kapcsolati sztring lekéréséhez.
```
az iot hub connection-string  show --hub-name {YourIoTHubName}
```
Másolja a kapcsolati sztring a környező idézőjelek nélkül.
Az Azure IoT Explorerben válassza az IoT Hubs lehetőséget a bal oldali menüben.
Válassza a + Kapcsolat hozzáadása lehetőséget.
Illessze be a kapcsolati sztring a Kapcsolati sztring mezőbe.
Válassza a Mentés lehetőséget.

Ha a kapcsolat sikeres, az IoT Explorer az Eszközök nézetre vált.

A nyilvános modell adattárának hozzáadása:

Az IoT Explorerben válassza a Kezdőlap lehetőséget a kezdőlap nézethez való visszatéréshez.
A bal oldali menüben válassza az IoT Plug and Play beállításai lehetőséget.
Győződjön meg arról, hogy van egy meglévő nyilvános adattárbejegyzés a következő végponttal https://devicemodels.azure.com: .

Feljegyzés

Ha nincs bejegyzés a nyilvános adattárban, válassza a +Hozzáadás lehetőséget, válassza a Nyilvános adattár lehetőséget a legördülő menüből, adja meg a végpont értékét, majd válassza a https://devicemodels.azure.com Mentés lehetőséget.

A nyilvános adattár befejezett bejegyzése a következő képernyőképhez hasonlóan néz ki:

Eszköz regisztrálása

Ebben a szakaszban létrehoz egy új eszközpéldányt, és regisztrálja azt a létrehozott IoT Hubon. Az újonnan regisztrált eszköz kapcsolati adataival biztonságosan csatlakoztathatja a fizikai eszközt egy későbbi szakaszban.

Eszköz regisztrálása:

Az IoT Explorer kezdőlap nézetében válassza az IoT Hubs lehetőséget.
A korábban hozzáadott kapcsolatnak meg kell jelennie. Válassza az Eszközök megtekintése a központban a kapcsolat tulajdonságai alatt lehetőséget.
Válassza az + Új lehetőséget, és adjon meg egy eszközazonosítót, például mydevice. Az összes többi tulajdonságot hagyja változatlanul.
Válassza a Létrehozás lehetőséget.
A másolási gombokkal másolja ki az eszközazonosító és az elsődleges kulcs mezőit.

Mielőtt továbblép a következő szakaszra, mentse az alábbi értékek mindegyikét a korábbi lépésekből egy biztonságos helyre. Ezeket az értékeket a következő szakaszban az eszköz konfigurálásához használhatja.

hostName
deviceId
primaryKey

Az eszköz előkészítése

Ha az ESP32 DevKitet az Azure-hoz szeretné csatlakoztatni, módosítsa a konfigurációs beállításokat, hozza létre a rendszerképet, és villogtasson a rendszerképet az eszközön.

A környezet beállítása

Az ESP-IDF-környezet elindítása:

Válassza a Windows Start lehetőséget, keresse meg az ESP-IDF 5.0 CMD-t, és futtassa.
Az ESP-IDF 5.0 CMD-ben keresse meg a korábban klónozott iot-middleware-freertos-samples könyvtárat.
Nyissa meg az ESP32-Azure IoT Kit projektkönyvtárat demos\projects\ESPRESSIF\aziotkit.
Futtassa a következő parancsot a konfigurációs menü elindításához:
```
idf.py menuconfig
```

Konfiguráció hozzáadása

Vezeték nélküli hálózati konfiguráció hozzáadása:

Az ESP-IDF 5.0 CMD-ben válassza az Azure IoT köztes szoftvereket a FreeRTOS-mintakonfigurációs --->, majd nyomja le az Enter billentyűt.
Adja meg a következő konfigurációs beállításokat a helyi vezeték nélküli hálózati hitelesítő adatokkal.

Beállítás Érték

WiFi SSID {Saját Wi-Fi SSID}

Wi-Fi-jelszó {Az Ön Wi-Fi-jelszava}
Válassza az Esc lehetőséget az előző menübe való visszatéréshez.

Beállítás	Érték
WiFi SSID	{Saját Wi-Fi SSID}
Wi-Fi-jelszó	{Az Ön Wi-Fi-jelszava}

Konfiguráció hozzáadása az Azure IoT Hubhoz való csatlakozáshoz:

Válassza az Azure IoT köztes szoftvereket a FreeRTOS fő feladatkonfigurációs --->, majd nyomja le az Enter billentyűt.

Állítsa be az alábbi Azure IoT-konfigurációs beállításokat az Azure-erőforrások létrehozása után mentett értékekre.

Beállítás	Érték
Azure IoT Hub teljes tartománynév	{A gazdagép neve}
Azure IoT-eszközazonosító	{Az eszköz azonosítója}
Az Azure IoT-eszköz szimmetrikus kulcsa	{Az elsődleges kulcs}

Feljegyzés

Az Azure IoT-hitelesítési módszer beállításában ellenőrizze, hogy a szimmetrikus kulcs alapértelmezett értéke van-e kiválasztva.

Válassza az Esc lehetőséget az előző menübe való visszatéréshez.

A konfiguráció mentése:

A mentési beállítások megnyitásához válassza a Shift+S lehetőséget. Ez a menü lehetővé teszi a konfiguráció mentését egy skconfig nevű fájlba az aktuális .\aziotkit könyvtárban.
A konfiguráció mentéséhez válassza az Enter billentyűt .
Válassza az Enter lehetőséget a nyugtázási üzenet elvetéséhez.
Válassza a Q lehetőséget a konfigurációs menüből való kilépéshez.

A kép létrehozása és villogása

Ebben a szakaszban az ESP-IDF-eszközökkel hozhatja létre, villogtathatja és figyelheti az ESP32 DevKitet, miközben csatlakozik az Azure IoT-hez.

Feljegyzés

Az ebben a szakaszban található alábbi parancsokban használjon egy rövid buildkimeneti útvonalat a gyökérkönyvtár közelében. Adja meg a buildelési útvonalat a -B paraméter után minden olyan parancsban, amelyhez szükség van rá. A rövid elérési út segít elkerülni az ESPRESSIF ESP-IDF-eszközök aktuális problémáját, amely hosszú buildelési útvonalnevekkel kapcsolatos hibákat okozhat. A következő parancsok egy helyi C:\espbuild elérési utat használnak példaként.

A rendszerkép létrehozása:

Az ESP-IDF 5.0 CMD-ben az iot-middleware-freertos-samples\demos\projects\ESPRESSIF\aziotkit könyvtárból futtassa a következő parancsot a rendszerkép létrehozásához.
```
idf.py --no-ccache -B "C:\espbuild" build 
```
A build befejezése után győződjön meg arról, hogy a bináris képfájl a korábban megadott buildelési útvonalon lett létrehozva.

C:\espbuild\azure_iot_freertos_esp32.bin

A kép villogásához:

Az ESP32 DevKiten keresse meg a Micro USB-portot, amely a következő képen van kiemelve:
Csatlakoztassa a Micro USB-kábelt az ESP32 DevKit micro USB-portjához, majd csatlakoztassa a számítógéphez.
Nyissa meg a Windows Eszközkezelő, és tekintse meg a portokat, hogy megtudja, melyik COM-porthoz csatlakozik az ESP32 DevKit.
Az ESP-IDF 5.0 CMD-ben futtassa a következő parancsot, és cserélje le a <Saját-COM-port> helyőrzőt és a zárójeleket az előző lépés megfelelő COM-portjára. Cserélje le például a helyőrzőt a következőre COM3: .
```
idf.py --no-ccache -B "C:\espbuild" -p <Your-COM-port> flash
```
Győződjön meg arról, hogy a kimenet a következő szöveggel fejeződik be egy sikeres flash esetén:
```
Hash of data verified

Leaving...
Hard resetting via RTS pin...
Done
```

Annak ellenőrzése, hogy az eszköz csatlakozik-e az Azure IoT Centralhoz:

Az ESP-IDF 5.0 CMD-ben futtassa a következő parancsot a monitorozási eszköz elindításához. Az előző parancshoz hasonlóan cserélje le a <Saját-COM-port> helyőrzőt és a zárójeleket arra a COM-portra, amelyhez az eszköz csatlakozik.
```
idf.py -B "C:\espbuild" -p <Your-COM-port> monitor
```

Ellenőrizze az alábbi példához hasonló ismétlődő kimeneti blokkokat. Ez a kimenet megerősíti, hogy az eszköz csatlakozik az Azure IoT-hez, és telemetriát küld.

I (50807) AZ IOT: Successfully sent telemetry message
I (50807) AZ IOT: Attempt to receive publish message from IoT Hub.

I (51057) MQTT: Packet received. ReceivedBytes=2.
I (51057) MQTT: Ack packet deserialized with result: MQTTSuccess.
I (51057) MQTT: State record updated. New state=MQTTPublishDone.
I (51067) AZ IOT: Puback received for packet id: 0x00000008
I (53067) AZ IOT: Keeping Connection Idle...

Eszköztulajdonságok megtekintése

Az Azure IoT Explorerrel megtekintheti és kezelheti az eszközök tulajdonságait. A következő szakaszokban az IoT Explorerben látható Plug and Play képességeket használja az ESP32 DevKit kezeléséhez és kezeléséhez. Ezek a képességek az ESP32 DevKit nyilvános modell adattárában közzétett eszközmodellre támaszkodnak. Az IoT Explorert úgy konfigurálta, hogy az oktatóanyag korábbi részében eszközmodelleket keressen az adattárban. Sok esetben ugyanezt a műveletet plug and play használata nélkül is végrehajthatja az IoT Explorer menübeállításainak kiválasztásával. A plug and play használata azonban gyakran továbbfejlesztett élményt nyújt. Az IoT Explorer beolvassa a plug and play eszköz által megadott eszközmodellt, és be tudja mutatni az adott eszközre vonatkozó információkat.

Az eszköz IoT Plug and Play-összetevőinek elérése az IoT Explorerben:

Az IoT Explorer otthoni nézetében válassza az IoT Hubok lehetőséget, majd válassza az Eszközök megtekintése lehetőséget ebben a központban.
Válassza ki az eszközt.
Válassza ki az IoT Plug and Play-összetevőket.
Válassza az Alapértelmezett összetevő lehetőséget. Az IoT Explorer megjeleníti az eszközön implementált IoT Plug and Play-összetevőket.

A Felület lapon tekintse meg a JSON-tartalmat az eszközmodell leírásában. A JSON az eszközmodell minden IoT Plug and Play-összetevőjének konfigurációs adatait tartalmazza.

Az IoT Explorer minden lapja megfelel az eszközmodell IoT Plug and Play-összetevőinek.

Lap	Típus	Név	Leírás
Interfész	Interfész	`Espressif ESP32 Azure IoT Kit`	Példa eszközmodell az ESP32 DevKithez
Tulajdonságok (írható)	Tulajdonság	`telemetryFrequencySecs`	Az az időköz, amelyet az eszköz telemetriát küld
Parancsok	Parancs	`ToggleLed1`	A LED be- vagy kikapcsolása
Parancsok	Parancs	`ToggleLed2`	A LED be- vagy kikapcsolása
Parancsok	Parancs	`DisplayText`	Az elküldött szöveg megjelenítése az eszköz képernyőjén

Eszköztulajdonságok megtekintése és szerkesztése az Azure IoT Explorerrel:

Válassza a Tulajdonságok (írható) lapot. Megjeleníti a telemetriai adatok küldésének időközét.
Módosítsa az telemetryFrequencySecs értéket 5 értékre, majd válassza a Kívánt érték frissítése lehetőséget. Az eszköz most ezt az időközt használja a telemetriai adatok küldéséhez.
Az IoT Explorer egy értesítéssel válaszol.

Az Azure CLI használata az eszköztulajdonságok megtekintéséhez:

Futtassa az az iot hub device-twin show parancsot.

az iot hub device-twin show --device-id mydevice --hub-name {YourIoTHubName}

Ellenőrizze az eszköz tulajdonságait a konzol kimenetében.

Tipp.

Az Azure IoT Explorer használatával is megtekintheti az eszköz tulajdonságait. A bal oldali navigációs sávon válassza az Ikereszköz lehetőséget.

Telemetria megtekintése

Az Azure IoT Explorerrel megtekintheti az eszközről a felhőbe irányuló telemetriai folyamatokat. Igény szerint ugyanezt a feladatot az Azure CLI-vel is elvégezheti.

Telemetria megtekintése az Azure IoT Explorerben:

Az IoT Plug and Play-összetevők (alapértelmezett összetevő) panelen válassza az IoT Explorerben a Telemetria lapot. Győződjön meg arról, hogy a beépített eseményközpont használata igen értékre van állítva.
Válassza az Indítás lehetőséget .
Tekintse meg a telemetriát, amikor az eszköz üzeneteket küld a felhőbe.
A modellezett események megjelenítése jelölőnégyzet bejelölésével megtekintheti az eseményeket az eszközmodell által megadott adatformátumban.
Válassza a Leállítás gombra az események fogadásának befejezéséhez.

Az Azure CLI használata az eszköz telemetriájának megtekintéséhez:

Futtassa az az iot hub monitor-events parancsot. Használja a korábban az Azure IoT-ben az eszközhöz és az IoT Hubhoz létrehozott neveket.
```
az iot hub monitor-events --device-id mydevice --hub-name {YourIoTHubName}
```

A JSON-kimenet megtekintése a konzolon.

{
    "event": {
        "origin": "mydevice",
        "module": "",
        "interface": "dtmi:azureiot:devkit:freertos:Esp32AzureIotKit;1",
        "component": "",
        "payload": "{\"temperature\":28.6,\"humidity\":25.1,\"light\":116.66,\"pressure\":-33.69,\"altitude\":8764.9,\"magnetometerX\":1627,\"magnetometerY\":28373,\"magnetometerZ\":4232,\"pitch\":6,\"roll\":0,\"accelerometerX\":-1,\"accelerometerY\":0,\"accelerometerZ\":9}"
    }
}

Válassza a CTRL+C billentyűkombinációt a figyelés befejezéséhez.

Közvetlen metódus meghívása az eszközön

Az Azure IoT Explorer használatával is meghívhat egy, az eszközön implementált közvetlen metódust. A közvetlen metódusoknak van egy neve, és opcionálisan JSON hasznos adatokkal, konfigurálható kapcsolattal és metódus-időtúllépéssel is rendelkezhetnek. Ebben a szakaszban egy olyan metódust hív meg, amely be- vagy kikapcsol egy LED-et. Igény szerint ugyanezt a feladatot az Azure CLI-vel is elvégezheti.

Metódus meghívása az Azure IoT Explorerben:

Az IoT Explorerben az eszköz IoT Plug and Play-összetevőinek (Alapértelmezett összetevő) paneljén válassza a Parancsok lapot.
A ToggleLed1 parancsnál válassza a Küldés parancsot. Az ESP32 DevKit LED-es kapcsolója be- vagy kikapcsol. Az IoT Explorerben is látnia kell egy értesítést.
A DisplayText parancshoz írjon be egy szöveget a tartalommezőbe.
Válassza a Küldés parancsot. A szöveg megjelenik az ESP32 DevKit képernyőn.

Metódus meghívása az Azure CLI használatával:

Futtassa az az iot hub invoke-device-method parancsot, és adja meg a metódus nevét és hasznos adatait. Ebben a módszerben true a led method-payload a jelenlegi állapotának ellenkezőjére vált.
```
az iot hub invoke-device-method --device-id mydevice --method-name ToggleLed2 --method-payload true --hub-name {YourIoTHubName}
```
A CLI-konzol megjeleníti a metódushívás állapotát az eszközön, amely 200 a sikerességet jelzi.
```
{
  "payload": {},
  "status": 200
} 
```
Ellenőrizze az eszközt a LED állapotának megerősítéséhez.

Hibaelhárítás és hibakeresés

Ha problémákat tapasztal az eszközkód létrehozása, az eszköz villogása vagy a csatlakozás során, tekintse meg a hibaelhárítást.

Az alkalmazás hibakereséséhez lásd a Visual Studio Code hibakeresését.

Az erőforrások eltávolítása

Ha már nincs szüksége az ebben a rövid útmutatóban létrehozott Azure-erőforrásokra, az Azure CLI használatával törölheti az erőforráscsoportot és annak összes erőforrását.

Fontos

Az erőforráscsoport törlése nem vonható vissza. Az erőforráscsoport és a benne foglalt erőforrások véglegesen törlődnek. Figyeljen arra, hogy ne töröljön véletlenül erőforráscsoportot vagy erőforrásokat.

Erőforráscsoport törlése név alapján:

Futtassa az az group delete parancsot. Ez a parancs eltávolítja az erőforráscsoportot, az IoT Hubot és a létrehozott eszközregisztrációt.
```
az group delete --name MyResourceGroup
```
Futtassa az az group list parancsot az erőforráscsoport törlésének megerősítéséhez.
```
az group list
```

Következő lépések

Ebben az oktatóanyagban létrehozott egy egyéni rendszerképet, amely tartalmazza a FreeRTOS-hez készült Azure IoT köztes szoftvert, majd a rendszerképet az ESP32 DevKit-eszközre villantotta fel. Csatlakoztatta az ESP32 DevKitet az Azure IoT Hubhoz, és olyan feladatokat hajtott végre, mint a telemetriai adatok megtekintése és a hívási módszerek az eszközön.

A következő lépésként tekintse meg a következő cikket, amelyből többet is megtudhat a beágyazott fejlesztési lehetőségekről.

További információ a beágyazott eszközök C SDK és Embedded C SDK használatával történő csatlakoztatásáról

Megosztás a következőn keresztül: