Merge branch 'development-publish' into AnkithB2020-patch-1

Author: AnkithB2020

amplify.yml

@@ -1,12 +1,12 @@
-version: 0.1
+version: 0.2
 frontend:
   phases:
     build:
       commands:
-        - wget https://github.com/gohugoio/hugo/releases/download/v0.54.0/hugo_0.54.0_Linux-64bit.tar.gz
-        - tar -xf hugo_0.54.0_Linux-64bit.tar.gz hugo
+        - wget https://github.com/gohugoio/hugo/releases/download/v0.58.3/hugo_0.58.3_Linux-64bit.tar.gz
+        - tar -xf hugo_0.58.3_Linux-64bit.tar.gz hugo
         - mv hugo /usr/bin/hugo
-        - rm -rf hugo_0.54.0_Linux-64bit.tar.gz
+        - rm -rf hugo_0.58.3_Linux-64bit.tar.gz
         - hugo
   artifacts:
     baseDirectory: public

config.toml

@@ -1,4 +1,4 @@
-baseURL = "https://docs.pycom.io/"
+baseURL = "https://development.pycom.io/"
 languageCode = "en-us"
 title = "documentation"
 uglyurls = false
@@ -198,12 +198,12 @@ theme = "doc-theme"
     parent = "gettingstarted@registration@lora"
     weight = 10
 
-# [[menu.main]]
-#     name = "Objenious"
-#     url = "/gettingstarted/registration/lora/objenious/"
-#     identifier = "gettingstarted@registration@lora@objenious"
-#     parent = "gettingstarted@registration@lora"
-#     weight = 20
+[[menu.main]]
+    name = "Objenious"
+    url = "/gettingstarted/registration/lora/objenious/"
+    identifier = "gettingstarted@registration@lora@objenious"
+    parent = "gettingstarted@registration@lora"
+    weight = 20
 
 # *** Pymakr Plugin
 [[menu.main]]
@@ -338,6 +338,13 @@ theme = "doc-theme"
     parent = "tutorials@all"
     weight = 10
 
+ [[menu.main]]
+    name = "PyGate"
+    url = "/tutorials/all/PyGate/"
+    identifier = "tutorials@all@PyGate"
+    parent = "tutorials@all"
+    weight = 10
+
 [[menu.main]]
     name = "WLAN"
     url = "/tutorials/all/wlan/"
@@ -520,6 +527,20 @@ theme = "doc-theme"
     parent = "tutorials@lora"
     weight = 70
 
+[[menu.main]]
+    name = "LoRa Mesh"
+    url = "/tutorials/lora/lora-mesh/"
+    identifier = "tutorials@lora@lora-mesh"
+    parent = "tutorials@lora"
+    weight = 80
+
+[[menu.main]]
+    name = "PyMesh Border Router"
+    url = "/tutorials/lora/pymesh-br/"
+    identifier = "tutorials@lora@pymesh-br"
+    parent = "tutorials@lora"
+    weight = 90
+
 [[menu.main]]
     name = "Sigfox Examples"
     url = "/tutorials/sigfox/"
@@ -611,26 +632,26 @@ theme = "doc-theme"
     parent = "firmwareapi@pycom@machine"
     weight = 10
 
+[[menu.main]]
+    name = "CAN"
+    url = "/firmwareapi/pycom/machine/can/"
+    identifier = "firmwareapi@pycom@machine@can"
+    parent = "firmwareapi@pycom@machine"
+    weight = 20
+
 [[menu.main]]
     name = "DAC"
     url = "/firmwareapi/pycom/machine/dac/"
     identifier = "firmwareapi@pycom@machine@dac"
     parent = "firmwareapi@pycom@machine"
-    weight = 20
+    weight = 30
 
 [[menu.main]]
     name = "I2C"
     url = "/firmwareapi/pycom/machine/i2c/"
     identifier = "firmwareapi@pycom@machine@i2c"
     parent = "firmwareapi@pycom@machine"
-    weight = 30
-
-[[menu.main]]
-    name = "Pin"
-    url = "/firmwareapi/pycom/machine/pin/"
-    identifier = "firmwareapi@pycom@machine@pin"
-    parent = "firmwareapi@pycom@machine"
-    weight = 40
+    weight = 35
 
 [[menu.main]]
     name = "PWM"
@@ -640,58 +661,58 @@ theme = "doc-theme"
     weight = 50
 
 [[menu.main]]
-    name = "RTC"
-    url = "/firmwareapi/pycom/machine/rtc/"
-    identifier = "firmwareapi@pycom@machine@rtc"
+    name = "Pin"
+    url = "/firmwareapi/pycom/machine/pin/"
+    identifier = "firmwareapi@pycom@machine@pin"
     parent = "firmwareapi@pycom@machine"
     weight = 60
 
 [[menu.main]]
-    name = "SPI"
-    url = "/firmwareapi/pycom/machine/spi/"
-    identifier = "firmwareapi@pycom@machine@spi"
+    name = "RMT"
+    url = "/firmwareapi/pycom/machine/rmt/"
+    identifier = "firmwareapi@pycom@machine@rmt"
     parent = "firmwareapi@pycom@machine"
     weight = 70
 
 [[menu.main]]
-    name = "UART"
-    url = "/firmwareapi/pycom/machine/uart/"
-    identifier = "firmwareapi@pycom@machine@uart"
+    name = "RTC"
+    url = "/firmwareapi/pycom/machine/rtc/"
+    identifier = "firmwareapi@pycom@machine@rtc"
     parent = "firmwareapi@pycom@machine"
     weight = 80
 
 [[menu.main]]
-    name = "WDT"
-    url = "/firmwareapi/pycom/machine/wdt/"
-    identifier = "firmwareapi@pycom@machine@wdt"
+    name = "SD"
+    url = "/firmwareapi/pycom/machine/sd/"
+    identifier = "firmwareapi@pycom@machine@sd"
     parent = "firmwareapi@pycom@machine"
     weight = 90
 
 [[menu.main]]
-    name = "Timer"
-    url = "/firmwareapi/pycom/machine/timer/"
-    identifier = "firmwareapi@pycom@machine@timer"
+    name = "SPI"
+    url = "/firmwareapi/pycom/machine/spi/"
+    identifier = "firmwareapi@pycom@machine@spi"
     parent = "firmwareapi@pycom@machine"
     weight = 100
 
 [[menu.main]]
-    name = "SD"
-    url = "/firmwareapi/pycom/machine/sd/"
-    identifier = "firmwareapi@pycom@machine@sd"
+    name = "Timer"
+    url = "/firmwareapi/pycom/machine/timer/"
+    identifier = "firmwareapi@pycom@machine@timer"
     parent = "firmwareapi@pycom@machine"
     weight = 110
 
 [[menu.main]]
-    name = "CAN"
-    url = "/firmwareapi/pycom/machine/can/"
-    identifier = "firmwareapi@pycom@machine@can"
+    name = "UART"
+    url = "/firmwareapi/pycom/machine/uart/"
+    identifier = "firmwareapi@pycom@machine@uart"
     parent = "firmwareapi@pycom@machine"
     weight = 120
 
 [[menu.main]]
-    name = "RMT"
-    url = "/firmwareapi/pycom/machine/rmt/"
-    identifier = "firmwareapi@pycom@machine@rmt"
+    name = "WDT"
+    url = "/firmwareapi/pycom/machine/wdt/"
+    identifier = "firmwareapi@pycom@machine@wdt"
     parent = "firmwareapi@pycom@machine"
     weight = 130
 
@@ -948,14 +969,20 @@ theme = "doc-theme"
     parent = "firmwareapi@micropython"
     weight = 90
 
-#  [Errno 2] No such file or directory: './content/firmwareapi/micropython/ustruct/README.md'
 [[menu.main]]
     name = "ustruct"
     url = "/firmwareapi/micropython/ustruct/"
     identifier = "firmwareapi@micropython@ustruct"
     parent = "firmwareapi@micropython"
     weight = 180
 
+[[menu.main]]
+    name = "uzlib"
+    url = "/firmwareapi/micropython/uzlib/"
+    identifier = "firmwareapi@micropython@uzlib"
+    parent = "firmwareapi@micropython"
+    weight = 200
+
 [[menu.main]]
     name = "_thread"
     url = "/firmwareapi/micropython/_thread/"

content/advance/downgrade.md

@@ -4,7 +4,6 @@ aliases:
     - advance/downgrade.html
     - advance/downgrade.md
     - chapter/advance/downgrade
-
 ---
 
 The firmware upgrade tool usually updates your device to the latest available firmware version. If you require to downgrade your device to a previous firmware there are two methods to achieve this.

content/docnotes/syntax.md

@@ -15,14 +15,12 @@ The Pycom documentation follows standard Python Library format using the popular
 The values of the arguments (as seen in the examples/docs) refer to the default values that are passed into the constructor if nothing is provided.
 
 ```python
-
 i2c.init(mode, * , baudrate=100000, pins=(SDA, SCL))
 ```
 
 An example of what this method might be called:
 
 ```python
-
 i2c.init(I2C.MASTER, pins=('P12', 'P11'))
 ```
 
@@ -37,12 +35,10 @@ It is important to note that there are certain class methods that can only accep
 An asterisk `*` in a method description \(in the docs\), denotes that the following arguments require a keyword, i.e. `pin='P16'` in the example below.
 
 ```python
-
 adc.channel(* , pin, attn=ADC.ATTN_0DB)
 ```
 
 ```python
-
 from machine import ADC
 
 adc = ADC()                     # create an ADC object
@@ -54,7 +50,6 @@ apin = adc.channel(pin='P16')   # create an analog pin on P16
 Another example shows how the `PWM` class, `pwm.channel()` requires a keyword argument for `pin` but does not for `id`.
 
 ```python
-
 from machine import PWM
 
 pwm = PWM(0, frequency=5000)
@@ -66,14 +61,12 @@ pwm_c = pwm.channel(0, pin='P12') # no keyword argument required for id (0) but
 The documentation may refer to a method that takes an argument listed by name but does allow for a keyword to be passed. For example, the `pycom` class contains a method `rgbled`. This lists that the method accepts a value for `color`, however this may not be specified by `keyword`, only `value`. This is intentional as the `value` being passed is the only argument valid for this method
 
 ```python
-
 pycom.rgbled(color)
 ```
 
 If the argument is passed into the method with a keyword, it will return an error stating TypeError: function does not take keyword arguments.
 
 ```python
-
 import pycom
 
 pycom.rgbled(color=0xFF0000) # Incorrect
@@ -83,12 +76,10 @@ pycom.rgbled(0xFF0000) # Correct
 Another example of a method that only accepts value input. In this case, the `RTC.init()` method require a value (`tuple`) input for the `datetime`. It will not accept a keyword.
 
 ```python
-
 rtc.init(datetime)
 ```
 
 ```python
-
 from machine import RTC
 
 rtc = RTC()
@@ -101,7 +92,6 @@ rtc.init((2014, 5, 1, 4, 13, 0, 0, 0)) # Correct
 The `constants` section of a library within the docs refers to specific values from that library's class. These might be used when constructing an object from that class or when utilising a method from within that class. These are generally listed by the library name followed by the specific value. See the example below:
 
 ```python
-
 I2C.MASTER()
 ```
 

content/firmwareapi/pycom/aes.md

@@ -15,7 +15,6 @@ AES is implemented using the ESP32 hardware module.
 ## Quick Usage Example
 
 ```python
-
 from crypto import AES
 import crypto
 key = b'notsuchsecretkey' # 128 bit (16 bytes) key

content/firmwareapi/pycom/machine/_index.md

@@ -46,6 +46,17 @@ Returns CPU frequency in hertz.
 
 Gates the clock to the CPU, useful to reduce power consumption at any time during short or long periods. Peripherals continue working and execution resumes as soon as any interrupt is triggered (on many ports this includes system timer interrupt occurring at regular intervals on the order of millisecond).
 
+#### machine.sleep(\[time\_ms\], resume\_wifi\_ble)
+
+Sets the device in to light sleep mode , where in this mode digital peripherals, most of the RAM, and CPUs are clock-gated, and supply voltage is reduced. Upon exit from light sleep, peripherals and CPUs resume operation, their internal state is preserved.
+
+* `time_ms` is the time in milliseconds that the device should wakeup after, if no time is given the device will sleep until the next reset cycle unless another wakeup source is configured.
+* `resume_wifi_ble` is a boolean value that enables or disable restoring after wakeup any WiFi or BLE connection that was interrupted by light sleep.
+* `True` Enable WiFi/BLE connections restoration
+* `False` Disable Wifi/BLE connections restoration, default option is Disabled
+
+_Note: in light sleep mode LoRa/Lte modems are stopped and have to be re-initialized after wakeup._
+
 #### machine.deepsleep(\[time\_ms\])
 
 Stops the CPU and all peripherals, including the networking interfaces (except for LTE). Execution is resumed from the main script, just as with a reset. If a value in milliseconds is given then the device will wake up after that period of time, otherwise it will remain in deep sleep until the reset button is pressed.
@@ -54,7 +65,7 @@ Products with LTE connectivity, such as the FiPy, GPy, G01, need to have the LTE
 
 #### machine.pin\_sleep\_wakeup(pins, mode, enable\_pull)
 
-Configure pins to wake up from sleep mode. The pins which have this capability are: `P2, P3, P4, P6, P8 to P10 and P13 to P23`.
+Configure pins to wake up from deep/light sleep mode. The pins which have this capability are: `P2, P3, P4, P6, P8 to P10 and P13 to P23`.
 
 The arguments are:
 

content/firmwareapi/pycom/machine/rtc.md

@@ -85,6 +85,24 @@ Returns `True` if the last `ntp_sync` has been completed, `False` otherwise:
 rtc.synced()
 ```
 
+#### rtc.memory(\[data\])
+
+Reads RTC memory contents or write data in passed Buffer in to RTC memory
+
+Example:
+
+```python
+rtc = RTC()
+rtc.memory(b'10101010') # writes data in RTC memory
+rtc.memory()
+```
+
+Output:
+
+```python
+b'10101010'
+```
+
 ## Constants
 
 * Clock source: `RTC.INTERNAL_RC`, `RTC.XTAL_32KHZ`

content/firmwareapi/pycom/machine/timer.md

@@ -72,7 +72,6 @@ Get the elapsed time in microseconds.
 Example:
 
 ```python
-
 from machine import Timer
 import time
 
@@ -111,7 +110,6 @@ Disables the alarm.
 Example:
 
 ```python
-
 from machine import Timer
 
 class Clock:

content/firmwareapi/pycom/machine/uart.md

@@ -83,7 +83,7 @@ On the GPy/FiPy UART2 is unavailable because it is used to communicate with the
 
 ## Methods
 
-#### uart.init(baudrate=9600, bits=8, parity=None, stop=1, \* , timeout\_chars=2, pins=(TXD, RXD, RTS, CTS))
+#### uart.init(baudrate=9600, bits=8, parity=None, stop=1, \* , timeout\_chars=2, pins=(TXD, RXD, RTS, CTS), rx\_buffer\_size=512)
 
 Initialise the UART bus with the given parameters:
 
@@ -93,6 +93,7 @@ Initialise the UART bus with the given parameters:
 * `stop` is the number of stop bits, `1 or 2`.
 * `timeout_chars` Rx timeout defined in number of characters. The value given here will be multiplied by the time a characters takes to be transmitted at the configured `baudrate`.
 * `pins` is a 4 or 2 item list indicating the TXD, RXD, RTS and CTS pins (in that order). Any of the pins can be `None` if one wants the UART to operate with limited functionality. If the RTS pin is given the the RX pin must be given as well. The same applies to CTS. When no pins are given, then the default set of TXD (P1) and RXD (P0) pins is taken, and hardware flow control will be disabled. If `pins=None`, no pin assignment will be made.
+* `rx_buffer_size` is the size of the buffer used for storing the RX packets. By default is is 512 bytes.
 
 #### uart.deinit()