[pymesh-ble] Changed in Pymesh BLE name pages, modified the OnOff exa… (#264)

* [pymesh-ble] Changed in Pymesh BLE name pages, modified the OnOff example

Author: Catalin Ioana

config.toml

@@ -381,7 +381,7 @@ theme = "doc-theme"
     weight = 30
 
 [[menu.main]]
-    name = "BLE Mesh"
+    name = "Pymesh BLE"
     url = "/tutorials/all/ble_mesh/"
     identifier = "tutorials@all@ble_mesh"
     parent = "tutorials@all"
@@ -829,7 +829,7 @@ theme = "doc-theme"
     weight = 60
 
 [[menu.main]]
-    name = "BLE Mesh"
+    name = "Pymesh BLE"
     url = "/firmwareapi/pycom/network/bluetooth/BLE_Mesh/"
     identifier = "firmwareapi@pycom@network@bluetooth@BLE_Mesh"
     parent = "firmwareapi@pycom@network@bluetooth"

content/firmwareapi/pycom/network/bluetooth/BLE_Mesh.md

@@ -1,36 +1,36 @@
 ---
-title: "BLE_Mesh"
+title: "Pymesh BLE"
 aliases:
     - firmwareapi/pycom/network/bluetooth/BLE_Mesh.html
     - firmwareapi/pycom/network/bluetooth/BLE_Mesh.md
 ---
 
-The BLE_Mesh library provides support for connecting to a BLE Mesh Network with various Server and Client models. Currently, Node cannot be configured as Provisioner.
-The library is under development, its current limitations:
-
-- Only one Element (primary) can be added to the Node.
-- Supported Models:
-    * Configuration Server Model (automatically generated together with primary Element)
-    * Generic OnOff Server Model
-    * Generic OnOff Client Model
-    * Generic Level Server Model
-    * Generic Level Client Model
-    * Sensor Server Model
-    * Sensor Client Model
- 
-- Supported OOB authentication types:
-    * No OOB
-    * Output OOB
- 
-- Supported Node Features:
-    * GATT Proxy
-    * Relay
-
-- Recommended Mobile Applications:
-    * nRF Mesh (iOS and Android)
-    * Silicon Labs Bluetoth Mesh (iOS)
-    * ST BLE Mesh (Android)
-    * EspBLEMesh (Android)
+The Pymesh BLE library provides support for connecting to a BLE Mesh Network with various Server and Client models.
+
+For examples, please check the section [Pymesh BLE Examples](/tutorials/all/ble_mesh).
+
+Pymesh BLE features:
+
+* Supported Models:
+ * Configuration Server Model (automatically generated together with primary Element)
+ * Generic OnOff Server Model
+ * Generic OnOff Client Model
+ * Generic Level Server Model
+ * Generic Level Client Model
+ * Sensor Server Model
+ * Sensor Client Model
+* Supported OOB authentication types:
+ * No OOB
+ * Output OOB
+* Supported Node Features:
+ * GATT Proxy
+ * Relay
+* Only one Element (primary) can be added to the Node.
+* Node cannot be configured as Provisioner and a mobile application should be used for Provisioning process
+ * nRF Mesh (iOS and Android)
+ * Silicon Labs Bluetoth Mesh (iOS)
+ * ST BLE Mesh (Android)
+ * EspBLEMesh (Android)
 
 
 ## Methods of BLE_Mesh class
@@ -42,7 +42,7 @@ Initializes the BLE Mesh module with the pre-configured Elements and Models.
 * `name` is the name which will be used to identify the device during Provisioning
 * `auth` is the Out-Of-Band (OOB) method. Currently `BLE_Mesh.OOB_OUTPUT` is supported. Without specifying this argument, `NO_OOB` will be used during provisioning.
 * `callback` is the callback to be registered. It must have the following arguments:
-    * `event` returns current event of provisioning. 
+    * `event` returns current event of provisioning.
     * `oob_pass` returns the generated pass in case of `BLE_Mesh.OOB_OUTPUT`.
 
 #### BLE_Mesh.set_node_prov(bearer=BLE_Mesh.PROV_NONE, *)
@@ -85,7 +85,7 @@ Gets the State of the Sensor Model. If called from Server Model, returnes with S
 
 * `addr` is the address of the remote Node to send the update message.
 * `app_idx` is the index of one of the registered Application IDs to use when sending out the message.
-* `state_type` is the type of Get State. 
+* `state_type` is the type of Get State.
 
 #### BLE_Mesh_Model.set_state(state, addr=BLE_Mesh.ADDR_ALL_NODES, app_idx=0, state_type=None)
 
@@ -94,15 +94,15 @@ Sets the State of the Sensor Model. If called from Server Model, sets State dire
 * `state` is the new value to update the current value with.
 * `addr` is the address of the remote Node to send the update message.
 * `app_idx` is the index of one of the registered Application IDs to use when sending out the message.
-* `state_type` is the type of Set State. 
+* `state_type` is the type of Set State.
 
 #### BLE_Mesh_Model.status_state(addr=BLE_Mesh.ADDR_ALL_NODES, app_idx=0, state_type=None)
 
 Calling this function only makes sense when the BLE_Mesh_Model is a Server Model. It sends a Status message with the State to the Client Model(s).
 
 * `addr` is the address of the remote Node to send the update message.
 * `app_idx` is the index of one of the registered Application IDs to use when sending out the message.
-* `state_type` is the type of Status State. 
+* `state_type` is the type of Status State.
 
 ## Constants
 

content/tutorials/all/ble_mesh.md

@@ -1,22 +1,35 @@
 ---
-title: "BLE Mesh"
+title: "Pymesh BLE Examples"
 aliases:
     - tutorials/all/ble_mesh.html
     - tutorials/all/ble_mesh.md
     - chapter/tutorials/all/ble_mesh
 ---
 
-BLE Mesh module enables many-to-many device connections, based on Bluetooth module.
+Pymesh BLE module enables many-to-many device connections, based on the Bluetooth module.
+
+For the API, please check the section [Pymesh BLE API](/firmwareapi/pycom/network/bluetooth/ble_mesh/).
+
+## Generic OnOff Example
+Generic OnOff model is one of the simplest model in BLE Mesh.
+
+This model illustrates the light-switches (OnOff Client) and light-bulbs (OnOff Server). In other words, the Client can send on/off commands to one/all nodes, and the Server is records state changes based on these commands.
+
+### OnOff Server
+
+OnOff Server has one boolean State. Server can Get, Set or send Status about this State to Client(s).
+
+In the example below, during Provisioning, `Output OOB` can be selected. LED is yellow in case of Not-provisioned, and green in case of Provisioned state.
+
+Changing the State of Server, LED's light is green or red.
 
-# Generic OnOff Example
-Generic OnOff model is simplest model in BLE Mesh, makes it possible for one device to switch other devices on or off.
-## OnOff Server
-OnOff Server has one bool State. Server can Get, Set or send Status abour this State to Client(s). In the example below, during Provisioning, `Output OOB` can be selected, LED is yellow in case of Unprovisioned, and green in case of Provisioned state. Changing the State of Server, LED's light is green or red.
 ```python
 from network import Bluetooth
 import pycom
 import time
 
+BLE_Name = "OnOff Server 18"
+
 def blink_led(n):
     for x in range(n):
         pycom.rgbled(0xffff00) # yellow on
@@ -41,6 +54,7 @@ def prov_callback(event, oob_pass):
         # Green if Provisioned
         pycom.rgbled(0x007f00)
     if(event == BLE_Mesh.PROV_OUTPUT_OOB_REQ_EVT):
+        print("Privisioning blink LED num:", oob_pass)
         blink_led(oob_pass)
 
 # BLE Mesh module
@@ -57,19 +71,39 @@ element = BLE_Mesh.create_element(primary=True, feature=BLE_Mesh.GATT_PROXY)
 model_server = element.add_model(BLE_Mesh.GEN_ONOFF, BLE_Mesh.SERVER, callback=server_cb)
 
 # Initialize BLE_Mesh
-BLE_Mesh.init("Pycom OnOff Server", auth=BLE_Mesh.OOB_OUTPUT, callback=prov_callback)
+BLE_Mesh.init(BLE_Name, auth=BLE_Mesh.OOB_OUTPUT, callback=prov_callback)
 
 # Turn on Provisioning Advertisement
 BLE_Mesh.set_node_prov(BLE_Mesh.PROV_ADV|BLE_Mesh.PROV_GATT)
+
+print("\nBLE Mesh started")
+print(BLE_Name, "waits to be provisioned\n")
+
+"""
+# After this node was provisioned
+# Current state can be read using
+model_server.get_state()
+"""
 ```
 
-## OnOff Client
-Client can Get or Set State of Server. In case of Get, or Server Status call, Client Gets the Status through the Model's callback.
+### OnOff Client
+
+Client can Get or Set State of Server. In case of Get, or Server Status, Client Gets the Status through the Model's callback.
+
 ```python
 from network import Bluetooth
 import pycom
 import time
 
+BLE_Name = "OnOff Client 17"
+
+def blink_led(n):
+    for x in range(n):
+        pycom.rgbled(0xffff00) # yellow on
+        time.sleep(0.3)
+        pycom.rgbled(0x000000) # off
+        time.sleep(0.3)
+
 def client_cb(new_state, event, recv_op):
     print("CLIENT | State: ", new_state)
 
@@ -80,6 +114,9 @@ def prov_callback(event, oob_pass):
     if(event == BLE_Mesh.PROV_COMPLETE_EVT):
         # Green if Provisioned
         pycom.rgbled(0x007f00)
+    if(event == BLE_Mesh.PROV_OUTPUT_OOB_REQ_EVT):
+        print("Privisioning blink LED num:", oob_pass)
+        blink_led(oob_pass)
 
 # BLE Mesh module
 BLE_Mesh = Bluetooth.BLE_Mesh
@@ -95,15 +132,34 @@ element = BLE_Mesh.create_element(primary=True, feature=BLE_Mesh.GATT_PROXY)
 model_client = element.add_model(BLE_Mesh.GEN_ONOFF, BLE_Mesh.CLIENT, callback=client_cb)
 
 # Initialize BLE_Mesh
-BLE_Mesh.init("Pycom OnOff Client", callback=prov_callback)
+BLE_Mesh.init(BLE_Name, auth=BLE_Mesh.OOB_OUTPUT, callback=prov_callback)
 
 # Turn on Provisioning Advertisement
 BLE_Mesh.set_node_prov(BLE_Mesh.PROV_ADV|BLE_Mesh.PROV_GATT)
+
+print("\nBLE Mesh started")
+print(BLE_Name, "waits to be provisioned\n")
+
+"""
+# After this node was provisioned
+# transmit the change of state broadcasting in the Mesh
+
+model_client.set_state(False, 0xFFFF)
+model_client.set_state(True, 0xFFFF)
+
+# or to a unique server
+model_client.set_state(False, 3)
+model_client.set_state(True, 5)
+
+"""
 ```
-# Sensor Example
+
+## Sensor Example
 In case of Sensor Models, State of Server can be modified only by Server itself, Client can only Get the State by calling Client's Get, or by Servers Status call, but cannot modify the Server's State.
-## Sensor Server
-In this example Server takes a time measurement every 1 seconds, and send a Status message every 5 seconds, after became Provisioned.
+
+### Sensor Server
+In this example Server takes a time measurement every 1 seconds, and send a Status message every 5 seconds, after it was provisioned.
+
 ```python
 from network import Bluetooth
 import pycom
@@ -157,8 +213,10 @@ Timer.Alarm(read_sensor, 1, periodic=True)
 Timer.Alarm(status_sensor, 5, periodic=True)
 ```
 
-## Sensor Client
+### Sensor Client
+
 Sensor Client is looking for measurements, as Server sends Status every 5 seconds. Between these calls, Client can Get message any time.
+
 ```python
 from network import Bluetooth
 import pycom