hri-362x

doc/_ext/_static/js/custom.js

@@ -2,7 +2,7 @@
 var P = [
     { text: "LoRa Gateway", value: "gateway"},
     { text: "Nodes", value: "node"},
-    { text: "Ready to Use", value: "ready_to_use"},
+    { text: "Plug & Play", value: "ready_to_use"},
  ]
 
 
@@ -30,7 +30,8 @@ var prod_obj = {
         {text:"HRI-485x", value: "hri-485x"},
         {text:"HRU-3601", value: "hru-3601"},
         {text:"HRU-1000", value: "hru-1000"},
-        {text:"HRI-362x", value: "hri-362x"},
+        {text:"HRI-3621", value: "hri-3621"},
+        {text:"HRI-3622", value: "hri-3622"},
         {text:"Wireless Bridge", value: "wireless_bridge"},
     ],
 }

doc/main/index.rst

@@ -54,12 +54,13 @@ Here are the LoRa Gateways produced by Heltec Automation. You will be able to fi
 
 .. toctree::
    :maxdepth: 2
-   :caption: Ready to Use
+   :caption: Plug&Play(Ready to Use)
 
-   HRI-485x <https://docs.heltec.org/en/ready_to_use/hri-485x/index.html>
-   HRU-3601 <https://docs.heltec.org/en/ready_to_use/hru-3601/index.html>
-   HRU-1000 <https://docs.heltec.org/en/ready_to_use/hru-1000/index.html>
-   HRI-362x <https://docs.heltec.org/en/ready_to_use/hri-362x/index.html>
+   HRI-485x(RS-485 Wireless converter) <https://docs.heltec.org/en/ready_to_use/hri-485x/index.html>
+   HRU-3601(Indoor environment monitor) <https://docs.heltec.org/en/ready_to_use/hru-3601/index.html>
+   HRU-1000(Wireless ThermoProbe) <https://docs.heltec.org/en/ready_to_use/hru-1000/index.html>
+   HRI-3621(Sensor Hub) <https://docs.heltec.org/en/ready_to_use/hri-3621/index.html>
+   HRI-3622(Sensor Hub Bus Transformer) <https://docs.heltec.org/en/ready_to_use/hri-3621/index.html>
    Sensor Hub for Outdoor <https://docs.heltec.org/en/ready_to_use/hri_485x/index.html>
    Wireless Bridge <https://docs.heltec.org/en/ready_to_use/wireless_bridge/index.html>
 

doc/ready_to_use/hri-3621/Makefile

@@ -0,0 +1,24 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@echo " make zh to update zh"
+
+.PHONY: help Makefile zh
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+zh:
+	sphinx-intl update -p build/gettext -l zh_CN

doc/ready_to_use/hri-3621/make.bat

@@ -0,0 +1,41 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+if "%1" == "zh" goto zh
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+echo.make zh to update zh
+
+goto end
+
+:zh
+sphinx-intl update -p build/gettext -l zh_CN
+:end
+popd

doc/ready_to_use/hri-3621/source/conf.py

@@ -0,0 +1,23 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'hri_485x'
+conf_py_path = '/doc/ready2use/hri-485x/source/'
+
+copyright = '2023, shug'
+author = 'shug'
+release = 'latest'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../../../_ext/'))
+from common_conf import *
+
+update_path(conf_py_path)

doc/ready_to_use/hri-3621/source/index.rst

@@ -0,0 +1,27 @@
+HRI-3621 Sensor Hub for Industry
+================================
+:ht_translation:`[简体中文]:[English]`
+
+[Sensor Hub](https://heltec.org/project/sensor-hub/) is a ready-to-use LoRa/LoRaWAN sensor for indoor (industrial) applications. Modular design allows for the replacement of sensor probes to adjust different projects. The device can be registered by one click via APP and Heltec Snap Emu IoT Platform.
+
+Sensor Hub for Industry has excellent low power consumption characteristics and LoRa provides Long-distance transmission capability. It comes with a built-in 1100mAh rechargeable battery and magnetic charging interface. The stainless-steel shell and high-strength plastic provide an IP66 protection level, allowing it to perform stably and excellently in complex industrial environments.
+
+
+
+**Sensor Hub have following main features:**
+
+- Industrial grade protection structure, IP66 protection grade.
+- Ultra-low power consumption design, built-in 1100mAh 18350 rechargeable battery.
+- Support LoRaWAN.
+- Support OTA, easy configure with in Web via WiFi.
+- Wireless data transmission communication radius up to 3~5km (no occlusion).
+- Compatible with wall fixing or cylinder fixing.
+
+.. toctree::
+    :maxdepth: 2
+
+    Quick Start <quick_start>
+    Connect to LoRaWAN Server <lorawan>
+    Subscribe MQTT Messages from LoRa Server <https://docs.heltec.org/general/subscribe_mqtt_messages.html>
+    OTA Upgrade<ota_upgrade>
+    -->[General Docs]<-- <https://docs.heltec.org/general/index.html>

doc/ready_to_use/hri-3621/source/lorawan.md

@@ -0,0 +1,94 @@
+# Connect to LoRaWAN Server
+
+{ht_translation}`[简体中文]:[English]`
+
+This topic describes how to connect the Sensor Hub for Industry to the LoRaWAN server.
+## Configure End Device
+Quickstart and entry into configuration mode for the HRI-362X is available here: [Quickstar](https://docs.heltec.org/en/ready_to_use/3621/quick_start.html).
+
+``` {Tip} The parameters need to be reconfigured after firmware upgrade.
+
+```
+## Configure LoRa Gateway
+You can find our recommended gateway on the [Heltec official website](https://heltec.org/) or shopping website, and find the gateway configuration method in [Documents page](https://docs.heltec.org/).
+
+We highly recommend the following three gateways:
+
+[HT-M02](https://heltec.org/project/ht-m02-v2/): Suitable for industry or field, with edge computing capabilities.
+
+[HT-M01s](https://heltec.org/project/ht-m01s-v2/): Standard indoor LoRa gateway with built-in screen.
+
+[HT-M7603](https://heltec.org/project/ht-m7603/): Indoor high cost performance gateway.
+
+### Register a LoRa Gateway
+For registering the gateway, please refer to the **Connect to LoRaWAN Server** section of the corresponding gateway's manual on the [Documents page](https://docs.heltec.org/).
+## Connect to TTN/TTS
+### Register End Device
++ Create a new **Application**, All the options are free to fill in.
+
+![](img/08.png)
++ Click the `register end device`.
+
+![](img/09.png)
+
++ Choose the way to register the node, it is recommended to `Enter end device specifics manually`, Select the frequency plan, LoRaWAN version, and fill in the corresponding joinEUI, click `confirmed`.
+
+``` {Tip} joinEUI corresponds to AppEUI on the device.
+
+```
+
+``` {Tip} As of November 2023, Heltec's products use LoRaWAN1.0.2 revision B.
+
+```
+![](img/10.png)
+
++ Fill in the `DevEUI` and `AppKey` of the device; The `End device ID` is automatically generated by the server. Click on `Register end divece`.
+
+![](img/11.png)
+
++ Click `General Setting` to check whether the configuration is correct, drop down to the `Network layer` option, click `Expand`, and continue to check.
+
+``` {Tip} The General Setting option is On the upper right corner. Be careful not to choose the wrong one. The General Setting option on the left is used to change the parameters of the Application.
+
+```
+
+``` {Tip} The default is Class_A after registration, and if the node is Class_C or Class_B, it needs to be selected and saved here.
+
+```
+
+![](img/12.png)
+
+After registration is complete, if all is well, you will see the device active.
+
+![](img/13.jpg)
+
+### Parsing
++ Click `payload formatters`, select `Custom Javascript formatter`, and enter decoding at the position in the figure. Download the decoder here: [https://resource.heltec.cn/download/Sensor%20Hub%20for%20industry](https://resource.heltec.cn/download/Sensor%20Hub%20for%20industry).
+
+![](img/14.jpg)
+
++ Click `Save change` and move the mouse to the uplink data output to view the data uploaded by HRU-3601.
+
+![](img/15.png)
+
+## Connect to ChirpStack
+
+Register a new device in ChirpStack’s “Applications” page. Enter the device name, description, DevEUI. Select Device-profile.
+
+![](img/20.png)
+
+Enter the Application key of the device.
+
+![](img/21.png)
+
+After registration is complete, if all is well, you will see the device active.
+
+![](img/22.png)
+
+## Important Hints
+
+Please double check the following two things:
+
+1. The LoRaWAN parameters is the same as server!
+2. The listening frequency of your LoRa Gateway is the same as ESP32 LoRa node's sending frequency. We strictly follow [LoRaWAN™ 1.0.2 Regional Parameters rB](https://resource.heltec.cn/download/LoRaWANRegionalParametersv1.0.2_final_1944_1.pdf);
+

doc/ready_to_use/hri-3621/source/ota_upgrade.md

@@ -0,0 +1,18 @@
+# OTA Upgrade
+
+{ht_translation}`[简体中文]:[English]`
+
++ Download firmware
+Search this link for the firmware version you want to download:
+[https://resource.heltec.cn/download/Sensor%20Hub%20for%20industry](https://resource.heltec.cn/download/Sensor%20Hub%20for%20industry/)
+
++ Enter configuration mode
+Press and hold the on key until the key indicator turns orange. Then the device enters the configuration mode.
+
++ Update Firmware
+Click `OTA Update`, select the firmware version you downloaded at first from the options that pop UP, and click `Upload Firmware`.
+
+![](img/update/01.png)
+
+## Relocation information
+After the upgrade is complete, all configurations will be reset. You need to go back to the configuration page to complete the configuration

doc/ready_to_use/hri-3621/source/quick_start.md

@@ -0,0 +1,73 @@
+# Getting Started
+
+{ht_translation}`[简体中文]:[English]`
+
+## Power supply
+HRI-3621 integrates a 1100aMh rechargeable lithium battery, charging voltage is 5V and its charging interface is magnetic-2P, a single filling time is about 3~4 hours.
+
+![](img/02.jpg) 
+
+## LED light status description
+The HRI-362x series has a wealth of indicator effects, which can help you more easily use the device, or determine the status of the device.
+
+![](img/led.png)
+
+## Configura
+### Enter Configuration mode
++ Long press the button on the top of the device, and the device will first display white light and then orange light. At this time, release your finger.
+
+``` {Tip} If the blue light/green light blinks sequentially after long press, it means that the device is in working state. After 5 seconds, when the light is all out and no longer blinks, release your finger and long press again to enter the configuration page.
+
+```
+
+![](img/03.jpg) 
+
++ Find the WiFi named **Sensor_Hub_xxxx** with your PC or mobile phone, connect it.
+
+![](img/04.png) 
+
++ In the browser, type **192.168.4.1**, enter the configuration page.
+
+![](img/05.png) 
+
+### Parameter Definition
+Configure the parameters according to specific requirements on the configuration page, and click `Submit` after the configuration is completed.The following is the definition of each parameter.
+
++ **Sensor Data Page**: This page will show real-time data when clicked, and you'll need to refresh it by clicking `Refresh`.
+
+  ![](img/06.png)
+
++ **LoRaWAN Configuration Page**: Shows the parameter configuration associated with LoRaWAN
+
+  ![](img/07.png)
+
+  - `Network access mode` LoRaWAN network access mode
+  - `NwkSKey` `appSKey` `devAddr` ABP node parameters, must be consistent across the server
+  - `RxWindow1Delay unit:S` Receive window 1 delay
+  - `RxWindow2Delay unit:S` Receive window 2 delay
+  - `Rx2dr` Window 2 data rate adaptive
+  - `DevEui`  `appEui`  `appKey` OTAA node parameters, must be consistent across the server
+  - `AppTxDutyCycle unit:S` Node transmission period
+  - `AppPort` AppPort
+  - `Channel_start` LoRaWAN channel start,
+  - `Channel_end` LoRaWAN channel end
+  - `LoRaWanClass`LoRaWAN Class A, Class C
+  - `IsTxConfirmed` Send Receive confirmation
+  - `LoRa signal light` Signal LED light switch
+  - `Adr` Data rate adaptation
+
++ **OTA UPDATE**: Sensor Hub for Industry series supports OTA upgrade.
+
+## Operating
++ After the configuration is completed, long press the button for five seconds, and when the light goes off, the device is shut down.
+
++ Press the button for 3 seconds. When the button shows white light, release the button. At this time, the device enters the working state, where the sending is green light and the receiving is purple light.
+
+## Common problems and solutions
++ Unable to confirm device working status.
+
+Press the device button once, and if it shows blue light, it will wake up, and the device will upload a message immediately.
+
++ Device not working
+
+After each configuration, you must button off in, then button on.

doc/ready_to_use/hri-3622/Makefile

@@ -0,0 +1,24 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@echo " make zh to update zh"
+
+.PHONY: help Makefile zh
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+zh:
+	sphinx-intl update -p build/gettext -l zh_CN