Skip to content

Commit

Permalink
Mesh node t114 quick start
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard3366 committed Aug 7, 2024
1 parent d6c20c1 commit 76b87a5
Show file tree
Hide file tree
Showing 132 changed files with 5,034 additions and 2 deletions.
1 change: 1 addition & 0 deletions doc/_ext/_static/js/custom.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ var prod_obj = {
node: [
{text: "Cubecell (ASR650x) Series", value: "asr650x"},
{text: "ESP32 Series", value: "esp32"},
{text: "Mesh Node T114", value: "nrf"},
{text: "STM32 Series", value: "stm32"},
{text: "Sufficient IoT Hub", value: "sufficient_iot_hub"},
{text: "HT-AT62", value: "ht-at62"},
Expand Down
1 change: 1 addition & 0 deletions doc/main/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Here are the LoRa Gateways produced by Heltec Automation. You will be able to fi

CubeCell(ASR650x) Series <https://docs.heltec.org/en/node/asr650x/index.html>
ESP32 Series <https://docs.heltec.org/en/node/esp32/index.html>
Mesh Node T114 <https://docs.heltec.org/en/node/nrf/index.html>
STM32 Series <https://docs.heltec.org/en/node/stm32/index.html>
Sufficient IoT Hub <https://docs.heltec.org/en/node/sufficient_iot_hub/index.html>
HT-AT62 <https://docs.heltec.org/en/node/ht-at62/index.html>
Expand Down
24 changes: 24 additions & 0 deletions doc/node/nrf/Makefile
Original file line number Diff line number Diff line change
@@ -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
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
68 changes: 68 additions & 0 deletions doc/node/nrf/build/gettext/capsule-sensor/assemble_a_battery.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2022, shug
# This file is distributed under the same license as the cubecell package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: cubecell \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-11-03 15:25+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: ../../source/capsule-sensor/assemble_a_battery.md:1
msgid "Assemble a battery to Capsule sensor"
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:2
msgid "{ht_translation}`[简体中文]:[English]`"
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:4
msgid "The capsule sensor is a global product, but because of international transportation, storage and other problems, **default is no integrated battery inside the Capsule sensor**."
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:6
#: ../../source/capsule-sensor/assemble_a_battery.md:12
#: ../../source/capsule-sensor/assemble_a_battery.md:16
#: ../../source/capsule-sensor/assemble_a_battery.md:26
msgid "&nbsp;"
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:8
msgid "After disassembling the sensor shell, you can see 2 pads on the round PCB at the bottom, and solder the battery positive and negative electrodes to this pad:"
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:10
msgid "![](img/assemble_a_battery/01.png)"
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:14
msgid "![](img/assemble_a_battery/02.png)"
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:18
msgid "Battery specifications"
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:20
msgid "In the capsule sensor, it's already integrates a charge management circuit, but does not have an over-discharge protection circuit, so **the lithium battery must have a protection circute**. Battery must include following features:"
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:22
msgid "Voltage: 3.7V"
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:23
msgid "Charging voltage: 4.2V"
msgstr ""

#: ../../source/capsule-sensor/assemble_a_battery.md:24
msgid "Discharge cut-off voltage: ≤3.3V"
msgstr ""
129 changes: 129 additions & 0 deletions doc/node/nrf/build/gettext/capsule-sensor/capsule_quick_start.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2022, shug
# This file is distributed under the same license as the cubecell package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: cubecell \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-11-03 15:25+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: ../../source/capsule-sensor/capsule_quick_start.md:1
msgid "Capsule Sensor Quick Start"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:2
msgid "{ht_translation}`[简体中文]:[English]`"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:3
msgid "Summary"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:5
msgid "**Pay attention to the following issues while using a capsule sensor**"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:7
msgid "The capsule sensor itself is positioned as a small-sized, assembled and deployed sensor. It does not have programming, debugging, and other interfaces. You need to use the [Debug Board](https://heltec.org/product/cubecell-capsule-debug/) in order to program and debug the program;"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:8
msgid "Due to storage and transportation issues, the battery is not integrated inside the capsule by default. Users in mainland China can inform our customer service when placing an order and we will provide integrated battery services."
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:9
msgid "[How to assemble a battery inside the Capsule Sensor](https://heltec-automation-docs.readthedocs.io/en/latest/cubecell/capsule-sensor/htcc-ac01/assemble_a_battery.html)"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:11
msgid "Get Ready"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:12
msgid "[Correctlly install CubeCell Arduino development framework](https://heltec-automation-docs.readthedocs.io/en/latest/cubecell/quick_start.html#install-cubecell-relevant-framework);"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:13
msgid "A high quality Micro USB cable;"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:14
msgid "[Connect Capsule to Debugger board](https://heltec-automation-docs.readthedocs.io/en/latest/cubecell/capsule-sensor/htcc-ac01/connect_capsule_to_debugger.html);"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:15
msgid "Install CP2102 USB-UART bridge driver."
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:16
msgid "*In most cases, Windows, Mac OS, and Linux will automatically recognize the CP2102 USB-UART bridge. If it is not recognized properly, please refer to [here](https://heltec-automation-docs.readthedocs.io/en/latest/general/establish_serial_connection.html).*"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:18
msgid "Capsule Sensor Test"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:20
msgid "Basic Test"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:22
msgid "In the example menu `CubeCell - xxxx Sensor Examples`, is the basic test program used by capsule sensors, which can be used to quickly verify the sensor and read the value from sensors:"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:24
msgid "![](img/capsule_quick_start/01.png)"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:26
msgid "**Heltec Produced Sensor Examples:** Sensor modules made by Heltec. Sensor List: `https://github.com/HelTecAutomation/ASR650x-Arduino/blob/master/libraries/SensorBasic/readme.md`"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:28
msgid "**Third Party Sensor Examples:** For third-party sensor modules developed by users. Sensor List: `https://github.com/HelTecAutomation/ASR650x-Arduino/blob/master/libraries/Sensor_ThirdParty/readme.md`"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:30
msgid "&nbsp;"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:32
msgid "Transmit Sensor Data Via LoRaWAN protocol"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:35
msgid "This part operations must performed with a gateway that supports the standard LoRaWAN protocol."
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:38
msgid "In the example menu `LoRa → LoRaWAN → LoRaWAN_Sensors(_ThirdParty)`, we provided some examples transmit sensor's data via LoRaWAN protocol."
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:40
msgid "![](img/capsule_quick_start/02.png)"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:42
msgid "In all sensor & LoRaWAN examples, the sensor data is read once before sending. For example, in the HDC1080 temperature and humidity sensor example:"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:53
msgid "The `PrepareTxFrame` had read temperature (float), humidity (float) and battery voltage (unsigned int). And convert data to a char. The contents:"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:93
msgid "Why convert data to byte?"
msgstr ""

#: ../../source/capsule-sensor/capsule_quick_start.md:95
msgid "Everyone knows that `float` data occupies 4 bytes in memory, and `unsigned int` data occupies 2 bytes. Suppose you have a very accurate sensor, for example, the measured data is 12.34567890987654321, if send this data via string like `char data[] = \"27.313232421875\"`, it will spend 15 bytes. but if transmit in byte `80 81 DA 41`, only spend 4 bytes."
msgstr ""
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2022, shug
# This file is distributed under the same license as the cubecell package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: cubecell \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-11-03 15:25+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:1
msgid "Connect Capsule to Debugger"
msgstr ""

#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:2
msgid "{ht_translation}`[简体中文]:[English]`"
msgstr ""

#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:4
msgid "The capsule sensor itself is positioned as a small-sized, assembled and deployed sensor. It does not have programming, debugging, and other interfaces. You need to use the [Debug Board](https://heltec.org/product/cubecell-capsule-debug/) in order to program and debug the program."
msgstr ""

#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:6
msgid "Both the capsule sensor body and the debug board have a round white marking point. When connecting, the position of the white points should be matched."
msgstr ""

#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:8
msgid "![](img/connect_capsule_to_debugger/01.png)"
msgstr ""

#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:10
#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:16
msgid "&nbsp;"
msgstr ""

#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:12
msgid "After the connection is completed, the sensor body and the debugging board are integrated into one body, and the pins are in a corresponding relationship, which is convenient for plugging in various sensors."
msgstr ""

#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:14
msgid "![](img/connect_capsule_to_debugger/02.png)"
msgstr ""

#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:18
msgid "**\"Capsule Master & Debugger Board & Sensor\"** correctlly assembled:"
msgstr ""

#: ../../source/capsule-sensor/connect_capsule_to_debugger.md:20
msgid "![](img/connect_capsule_to_debugger/03.png)"
msgstr ""
53 changes: 53 additions & 0 deletions doc/node/nrf/build/gettext/capsule-sensor/index.pot
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2022, shug
# This file is distributed under the same license as the cubecell package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: cubecell \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-11-03 15:25+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: ../../source/capsule-sensor/index.rst:7
msgid "Quick Start"
msgstr ""

#: ../../source/capsule-sensor/index.rst:7
msgid "Assemble a Battery"
msgstr ""

#: ../../source/capsule-sensor/index.rst:7
msgid "Connect Capsule Sensor to Debugger"
msgstr ""

#: ../../source/capsule-sensor/index.rst:7
msgid "Sensor Pinout Diagram"
msgstr ""

#: ../../source/capsule-sensor/index.rst:2
msgid "CubeCell Capsule Sensor"
msgstr ""

#: ../../source/capsule-sensor/index.rst:3
msgid ":ht_translation:`[简体中文]:[English]`"
msgstr ""

#: ../../source/capsule-sensor/index.rst:5
msgid "CubeCell Capsule sensor relevant documents."
msgstr ""

#: ../../source/capsule-sensor/index.rst:16
msgid "Relevant Offical Resources"
msgstr ""

#: ../../source/capsule-sensor/index.rst:18
msgid "`Schematic diagram <https://resource.heltec.cn/download/CubeCell/Capsule/Capsule_MCU_Part_Schematic_Diagram.pdf>`_."
msgstr ""
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2022, shug
# This file is distributed under the same license as the cubecell package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: cubecell \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2022-11-03 15:25+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#: ../../source/capsule-sensor/sensor_pinout_diagram.md:1
msgid "Sensor Pinout Diagram"
msgstr ""

#: ../../source/capsule-sensor/sensor_pinout_diagram.md:2
msgid "{ht_translation}`[简体中文]:[English]`"
msgstr ""

#: ../../source/capsule-sensor/sensor_pinout_diagram.md:4
msgid "![](img/sensor_pinout_diagram/BH1750.png)"
msgstr ""

#: ../../source/capsule-sensor/sensor_pinout_diagram.md:6
msgid "![](img/sensor_pinout_diagram/BMP180.png)"
msgstr ""

#: ../../source/capsule-sensor/sensor_pinout_diagram.md:8
msgid "![](img/sensor_pinout_diagram/CCS811.png)"
msgstr ""

#: ../../source/capsule-sensor/sensor_pinout_diagram.md:10
msgid "![](img/sensor_pinout_diagram/HDC1080.png)"
msgstr ""

#: ../../source/capsule-sensor/sensor_pinout_diagram.md:12
msgid "![](img/sensor_pinout_diagram/MPU9250.png)"
msgstr ""
Loading

0 comments on commit 76b87a5

Please sign in to comment.