diff --git a/docs/Network/SenseCAP_Network/SenseCAP_M2_Multi_Platform/Home_Assistant.md b/docs/Network/SenseCAP_Network/SenseCAP_M2_Multi_Platform/Home_Assistant.md new file mode 100644 index 000000000000..312e22d57ba2 --- /dev/null +++ b/docs/Network/SenseCAP_Network/SenseCAP_M2_Multi_Platform/Home_Assistant.md @@ -0,0 +1,146 @@ +--- +description: Home Assistant Intergration for SenseCAP LoRaWAN Sensors +title: SenseCAP For HomeAssistant +keywords: +- SenseCAP M2 Multi-Platform +- Home Assistant +- LoRaWAN Sensors + +last_update: + date: 10/19/2023 + author: JoJang +--- + +# Automatic intergrate all your SenseCAP Sensors to Home Assistant +

pir

+ +## 1. SenseCAP M2 Multi-Platform Configuration +### 1.1 LoRa Network Configuration +**Step 1.** Click **LoRa** and choose **LoRa Network** +
+ +**Step 2.** Choose Local Network Server mode and fill your MQTT host information **(Include your host, username, password and port).** Then Click **Save&&Apply** +
+ +At this point we have finished the server mode setup, and we wiil configure the ChirpStack later. + + +### 1.2 ChirpStack Configuration + +**Step 1.** Open the ChirpStack configuration page, then **Click Device profiles** +
+ +**Step 2.** Click **Add device profile** +
+ +**Step 3.** First, fill in the device profile according to your SenseCAP configuration: **Name, Region, MAC version**, and **Regional parameters revision**, in which the **Expected uplink interval** needs to be changed to **120**, and this one can be adjusted according to your own requirements. In the second step, we Click the **Codec** at the top +
+ +**Step 4.** In this step, we need to choose the decoder according to our Sensor model, the code can be found [Here](https://github.com/Seeed-Solution/SenseCAP-Decoder.git). We need to select the code in the **TTN** folder as our decoder. +
+ +**Step 5.** Next step, we are going to add devices. Click **Applications** +
+ +**Step 6.** Click **Add applications** +
+ +**Step 7.** Fill the application information and Click **Submit** +
+ +**Step 8.** Click **Add device** +
+ +**Step 9.** Fill your device information and Click **Submit** +
+ +**Step 10.** Click the **DevEUI** of your devices to turn the page +
+ +**Step 11.** Click **OTAA keys** and enter your **Application key** of the SenseCAP Sensor. Then Click **Submit** +
+ +**Step 12.** Activate your SenseCAP Sensor and wait for it to automatically connect to LoRaWAN. Then you can see the data uploaded by the sensor in the **Events** and **LoRaWAN frames** +
+ +**Step 13.** At this point, we have completed all configurations of the M2 gateway. +
+ + + + + + + +## 2. Home Assistant Configuration +### 2.1 Install + +**1.HACS** +- First installation + > HACS > Integrations > ➕ EXPLORE & DOWNLOAD REPOSITORIES > [`Seeed Studio-SenseCAP`](https://my.home-assistant.io/redirect/hacs_repository/?owner=Seeed-Solution&repository=https%3A%2F%2Fgithub.com%2FSeeed-Solution%2Fhome-assistant-SenseCAP.git) > DOWNLOAD THIS REPOSITORY +- Update component + > HACS > Integrations > [`Seeed Studio-SenseCAP`](https://my.home-assistant.io/redirect/hacs_repository/?owner=Seeed-Solution&repository=https%3A%2F%2Fgithub.com%2FSeeed-Solution%2Fhome-assistant-SenseCAP.git) > UPDATE / Redownload + +**2.Install via SSH & Web Terminal add-on** + +1. Open SSH Terminal and enter the following command: +``` +cd ~/config/custom_components && git clone https://github.com/Seeed-Solution/home-assistant-SenseCAP.git && cd home-assistant-SenseCAP/custom_components && mv sensecap ../../ && cd ../../ && rm -r home-assistant-SenseCAP +``` +
+ +2. Restart HA core +3. Add Intergration +
+ + +### 2.2 Configuration +1. Enter your MQTT information and Click **SUBMIT** +
+ +2. Waiting for few minutes (**The Uplink time depends on your setting in M2 Chirpstack and SenseCAP Mate APP**), and Click **Notifications** in the left sidebar. Then we can see the SenseCAP Sensors have been automatically added to HA. Click **Check it out** and turn to the Intergration +
+ +3. Click on one of the devices and we can see that all of the entities have been automatically created and added to the device. Click **ADD TO DASHBOARD** so as to add all the entites of entire device directly to the dashboard through the form of cards + +
+ +4. Go to **Overview** and we can find the card we just added + +
+ +5. Click **Edit dashboard** + +
+ +6. Click **EDIT** to edit + +
+ +7. We can add a header Picture to decorate the card + +
+ +8. Replace the url to yours in order to display your favorite picture + +
+ +9. Choose the entity to modify + +
+ +10. Change the icon to one that is similar to the type of sensor entity + +
+ +11. We have now completed the entire plugin configuration process here. Subsequently, you can perform custom optimizations according to your own requirements + +
+ +12. Here are the visual representations of the effects on the "Overview" page after adding various models of SenseCAP sensors. + + +The aforementioned constitutes the complete step-by-step tutorial for integrating SenseCAP into the Home Assistant platform. Home Assistant has the capability to seamlessly integrate different types of devices from various platforms into a single ecosystem, facilitating cross-platform interoperability. This holds profound significance for the comprehensiveness of the smart home ecosystem. Presently, Seeed has also become a part of the extensive Home Assistant community, enabling the integration of our SenseCAP devices into the platform. We believe that this endeavor will contribute to the further strengthening and growth of the Internet of Things ecosystem! + + + diff --git a/docs/Sensor/SenseCAP/SenseCAP_T1000_Tracker/Tracker_WiFi_Geolocation.md b/docs/Sensor/SenseCAP/SenseCAP_T1000_Tracker/Tracker_WiFi_Geolocation.md index c3da2659651c..2e1e401fabca 100644 --- a/docs/Sensor/SenseCAP/SenseCAP_T1000_Tracker/Tracker_WiFi_Geolocation.md +++ b/docs/Sensor/SenseCAP/SenseCAP_T1000_Tracker/Tracker_WiFi_Geolocation.md @@ -185,11 +185,6 @@ If you don't have running conditions, you can easily run the [Colab notebook](ht - - - - - ## 2.2 Baidu Map In this tutorial, we have chosen to use the intelligent hardware positioning service provided by the **Baidu Map** Open Platform to perform location analysis on the Wi-Fi information we have obtained. The access methods may vary for different location service providers, and here we are using IP whitelist authentication. The specific access process involves defining the data package we need to parse and then making a POST request to the API service address. Below is the JSON data package we have defined. diff --git a/sidebars.js b/sidebars.js index b54f20acf605..fe98f0df773b 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1891,6 +1891,7 @@ const sidebars = { 'Network/SenseCAP_Network/SenseCAP_M2_Multi_Platform/SenseCAP_M2_Multi_Platform_Overview', 'Network/SenseCAP_Network/SenseCAP_M2_Multi_Platform/SenseCAP_M2_MP_Gateway_LNS_Configuration', 'Network/SenseCAP_Network/SenseCAP_M2_Multi_Platform/Quick_Start', + 'Network/SenseCAP_Network/SenseCAP_M2_Multi_Platform/Home_Assistant', { type: 'category', label: 'Tutorial',