Merge pull request #257 from pycom/pb-716-pybytes-pymesh-integration-doc

PR pymesh provisioning and monitoring doc

config.toml

@@ -1453,6 +1453,13 @@ theme = "doc-theme"
     parent = "pybytes"
     weight = 80
 
+ [[menu.main]]
+     name = "Pymesh Integration"
+     url = "/pybytes/pymeshintegration/"
+     identifier = "pybytes@pymeshintegration"
+     parent = "pybytes"
+     weight = 90
+
 [[menu.main]]
     name = "Amazon IoT"
     url = "/pybytes/integrations/amazon-iot/"

content/pybytes/pymeshIntegration/_index.md

@@ -0,0 +1,12 @@
+---
+title: "Pymesh Integration"
+aliases:
+---
+
+This documentation is a quick introduction to the new Pymesh integration features on Pybytes.
+
+The Pymesh integration is here to help Pymesh firmware deployment and to monitor Pymesh node's health.
+
+[**Pymesh Provisioning**](/pybytes/pymeshintegration/provisioning)
+
+[**Pymesh Monitoring**](/pybytes/pymeshintegration/monitoring)

content/pybytes/pymeshIntegration/monitoring.md

@@ -0,0 +1,17 @@
+## Pymesh Monitoring
+
+Once the Pymesh is working is possible to see Pymesh monitoring data on the Pymesh interface.
+
+At Pymesh Structure, is visible the device name, role and Lora Mac.
+
+![Pymesh Structure](/gitbook/assets/pybytes/pymesh/pymesh_monitoring_data.png)
+
+Pymesh Monitoring shows the devices as a node, the last node's border router, the last connection and the number of neighbors.
+
+![Pymesh Monitoring](/gitbook/assets/pybytes/pymesh/pymesh_monitoring_monitoring.png)
+
+If the user clicks on the devices and go to the **Signal** interface, the user can see the data that the node is exchanging on the Pymesh.
+
+![Devices Signal](/gitbook/assets/pybytes/pymesh/device_signal.png)
+
+To illustrate the Pymesh Provisioning, check [**Pymesh Provisioning**](/pybytes/pymeshintegration/provisioning)

content/pybytes/pymeshIntegration/provisioning.md

@@ -0,0 +1,66 @@
+## Pymesh Provisioning
+
+In the flow below, a single device is being used to illustrate the provisioning, but the user can use as many devices is necessary.
+
+The Pymesh is created under a project, the project interface was extended with the new Pymesh features.
+
+In the screen below there are 2 previously set up projects. Let's go first with the Pymesh Provisioning were we can see the lopy4, that is running the v1.20 firmware version.
+
+![Project interface extended with the Pymesh feature](/gitbook/assets/pybytes/pymesh/project_ui.png)
+
+
+Is possible to create one Pymesh per project.
+
+Once clicking on **Create Pymesh** button, the user will be guided through a wizard, where will be guided to set up the new Pymesh in 4 steps.
+
+![Create Pymesh](/gitbook/assets/pybytes/pymesh/pymesh_provisioning_create_pymesh.png)
+
+### Pymesh Wizard
+
+#### The first step is the license agreement.
+
+After the reading, if the user agrees with the terms, the user should tick the checkmark and click on Next button.
+
+![Pymesh license agreement](/gitbook/assets/pybytes/pymesh/pymesh_license.png)
+
+#### The second step is the device selection.
+
+All devices eligible to be part of a Pymesh, will be under this list. The user should select the devices and click on the Next button.
+
+![Pymesh device selection](/gitbook/assets/pybytes/pymesh/pymesh_select_devices.png)
+
+#### The third step is the Pymesh Settings.
+
+All parameters are filled with default values, if the user needs to change it, it's possible.
+
+If all the parameters are ok, the user should generate the join-key, and go ahead.
+
+The join-key is what makes the Pymesh unique, In the generate join-key box the user can have more information about the use of the join-key.
+
+If the user wants extra information about each field, hover the mouse over the question mark, and the information will appear.
+
+![Pymesh settings](/gitbook/assets/pybytes/pymesh/pymesh_settings_form.png)
+
+#### The last step is the Pymesh settings summary.
+
+Here the user can check if all information is correct. If everything is fine, the user can go ahead and save the Pymesh settings.
+
+![Pymesh settings summary](/gitbook/assets/pybytes/pymesh/pymesh_summary.png)
+
+### And here is the Pymesh.
+
+On this interface, the user can add or remove devices from the Pymesh. The user can also go to configuration, and change the Pymesh settings if it is necessary.
+
+To deploy the Pymesh Settings and Pymesh Firmware into the devices, click on the **Deploy Pymesh** button.
+
+![Pymesh](/gitbook/assets/pybytes/pymesh/pymesh_monitoring_struct.png)
+
+Once clicking, the user has a warning message, the update takes up a minute and then there are the confirmation message.
+
+![Pymesh deployment warning message](/gitbook/assets/pybytes/pymesh/pymesh_warning_message.png)
+
+Now the device is properly configured with the Pymesh settings and Pymesh firmware.
+
+All the user needs to do is implement their own script on the well-know **main.py** file.
+
+To illustrate the Pymesh behavior, check [**Pymesh Monitoring**](/pybytes/pymeshintegration/monitoring)

themes/doc-theme/static/css/doc-theme.css

@@ -342,7 +342,7 @@ html {
   scroll-padding-top: 70px; /* height of sticky header */
 }
 
-img[src*="/gitbook/assets/pybytes/lora/screenshots"]{
+img[src*="/gitbook/assets/pybytes/lora/screenshots"], img[src*="/gitbook/assets/pybytes/pymesh"]{
     margin-top: 20px;
     margin-left: 15px;
     box-shadow: 1px 1px 4px rgba(0, 0, 0, 0.3);
@@ -355,3 +355,7 @@ img[src="/gitbook/assets/pybytes/lora/chirpstack_logo.png"]{
 img[src="/gitbook/assets/pybytes/lora/ttn_logo.svg"]{
     width: 130px;
 }
+
+img[src*="/gitbook/assets/pybytes/pymesh/"]{
+    width: 70%;
+}