Cleanup

chapter/datasheets/development/template.md

@@ -1,120 +0,0 @@
-<p align="center"><img src ="../../../img/{{module|lower}}.png" width="300"></p>
-
-{% if module=="WiPy2" %}
-**Store**: Discontinued, See [WiPy3](./wipy3.md)
-
-**Getting Started** [Click Here](../../gettingstarted/connection/wipy.md)
-{% elif module=="WiPy3" %}
-**Store**: [Buy Here](http://www.pycom.io/wipy-3)
-
-**Getting Started** [Click Here](../../gettingstarted/connection/wipy.md)
-{% else %}
-**Store**: [Buy Here](http://www.pycom.io/{{module | lower}})
-
-**Getting Started** [Click Here](../../gettingstarted/connection/{{module|lower}}.md)
-{% endif %}
-
-## Pinout
-The pinout of the {{module}} is available as a
-<a href="../downloads/{{module | lower}}-pinout.pdf" target="_blank">PDF File</a>.
-
-<a href="../downloads/{{module | lower}}-pinout.pdf" target="_blank" align="center"><img src ="../../../img/{{module | lower}}-pinout.png"></a>
-
-{% hint style='info' %}
-Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK,MOSI,MISO)
-and I2C (SDA,SCL) are defaults and can be changed in Software.
-{% endhint %}
-
-{% if module=="WiPy3" %}
-## Differences from WiPy 2.0
- - Deep sleep current draw fixed, now only 19.7µA
- - Upgraded RAM from 512KB to 4MB
- - Upgraded External FLASH from 4MB to 8MB
- - Antenna select pin moved from GPIO16 to GPIO21 (P12)
-{% endif %}
-
-## Datasheet
-The datasheet of the {{module}} is available as a
-<a href="../downloads/{{module | lower}}-specsheet.pdf" target="_blank">PDF File</a>.
-
-## Notes
-
-### WiFi
-By default, upon boot the {{module}} will create a WiFi access point with the
-SSID {% if module=="WiPy2" or module=="WiPy3" or module=="W01" %}
-`wipy-wlan-XXXX`
-{% elif module=="LoPy" or module=="L01" %}
-`lopy-wlan-XXXX`
-{% elif module=="LoPy4" or module=="L04" %}
-`lopy4-wlan-XXXX`
-{% elif module=="GPy" or module=="G01" %}
-`gpy-wlan-XXXX`
-{% else %}
-`{{module|lower}}-wlan-XXXX`
-{% endif %}, where `XXXX` is a random 4-digit number, and the password
-`www.pycom.io`.
-
-{% if module=="WiPy3" or module=="LoPy4" or module=="GPy" or module=="FiPy"%}
-The RF switch that selects between the on-board and external antenna is connected
-to `P12`, for this reason using `P12` should be avoided unless WiFi is disabled
-in your application.
-{% endif %}
-
-{% if module=="WiPy2" or module=="WiPy3" or module=="LoPy" or module=="LoPy4" or module=="GPy" or module=="FiPy" or module=="SiPy"%}
-### Power
-The `Vin` pin on the {{module}} can be supplied with a voltage ranging from
-`3.5v` to `5.5v`. The `3.3v` pin on the other hand is output **only**, and must
-not be used to feed power into the {{module}}, otherwise the on-board regulator
-will be damaged.
-{% endif %}
-
-{% if module=="LoPy" or module=="SiPy" or module=="WiPy2"%}
-### Deep Sleep
-Due to a couple issues with the {{module}} design the module draws more current
-than it should while in deep sleep. The DC-DC switching regulator always stays
-in high performance mode which is used to provide the lowest possible output
-ripple when the modules is in use. In this mode, it draws a quiescent current of
-10mA. When the regulator is put into ECO mode, the quiescent current goes down
-to 10uA. Unfortunately, the pin used to control this mode is out of the RTC
-domain, and therefore not usable during deep sleep. This causes the regulator to
-always stay in PWM mode, keeping its quiescent current at 10mA. Alongside this
-the flash chip doesn't enter power down mode because the CS pin is floating
-during deep sleep. This causes the flash chip to consume around 2mA of current.
-To work around this issue a ["deep sleep shield"](../boards/deepsleep.md) is
-available that attaches to the module and allows power to be cut off from the
-device. The device can then be re-enabled either on a timer or via pin
-interrupt. With the deep sleep shield the current consumption during deep sleep
-is between 7uA and 10uA depending on the wake sources configured.
-{% endif %}
-
-{% if module=="GPy" or module=="FiPy" %}
-### AT Commands
-
-The AT commands for the Sequans Monarch modem on the {{module}} are available in a
-<a href="../downloads/Monarch_4G-EZ_LR5110_ATCommands_ReferenceManual_Rev3_NOCONFIDENTIAL.pdf">PDF file</a>.
-{% endif %}
-
-## Tutorials
-Tutorials on how to the {{ module }} module can be found in the
-[examples](../../tutorials/README.md) section of this documentation. The following tutorials might be of
-specific interest for the {{ module }}:
-
-- [WiFi connection](../../tutorials/all/wlan.md)
-
-{% if module=="LoPy" or module=="LoPy4" or module=="FiPy" %}
-- [LoRaWAN node](../../tutorials/lora/lorawan-otaa.md)
-
-- [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md)
-
-{% endif %}
-{% if module=="SiPy" or module=="LoPy4" or module=="FiPy" %}
-- [Sigfox](../../tutorials/sigfox/README.md)
-
-{% endif %}
-{% if module=="GPy" or module=="FiPy" %}
-- [LTE CAT-M1](../../tutorials/lte/cat_m1.md)
-
-- [NB-IoT](../../tutorials/lte/nb_iot.md)
-
-{% endif %}
-- [BLE](../../tutorials/all/ble.md)

chapter/datasheets/oem/template.md

@@ -1,42 +0,0 @@
-<p align="center"><img src ="../../../img/{{module | lower}}.png" width="300"></p>
-
-### Pinout
-The pinout of the {{module}} is available as a <a href="../downloads/{{module|lower}}-pinout.pdf" target="_blank">PDF File</a>.
-
-<a href="../downloads/{{module|lower}}-pinout.pdf" target="_blank" align="center"><img src ="../../../img/{{module|lower}}-pinout.png"></a>
-
-### Specsheets
-
-The specsheet of the {{module}} is available as a <a href="../downloads/{{module|lower}}-specsheet.pdf" target="_blank">PDF File</a>.
-
-### Drawings
-
-The drawings for the {{module}} is available as a <a href="../downloads/{{module|lower}}-drawing.pdf" target="_blank">PDF File</a>.
-
-Please note that the PIN assignments for UART1 (TX1/RX1), SPI (CLK, MOSI, MISO) and I2C (SDA, SCL) are defaults and can be changed in Software.
-
-{% if module=="G01" %}
-###AT Commands
-
-The AT commands for the Sequans Monarch modem on the {{module}} are available in a
-<a href="../downloads/Monarch_4G-EZ_LR5110_ATCommands_ReferenceManual_Rev3_NOCONFIDENTIAL.pdf">PDF file</a>.
-{% endif %}
-
-## Tutorials
-Tutorials on how to the {{ module }} module can be found in the
-[examples](../../tutorials/README.md) section of this documentation. The following tutorials might be of
-specific interest for the {{ module }}:
-
-- [WiFi connection](../../tutorials/all/wlan.md)
-{% if module=="L01" or module=="L04" %}
-- [LoRaWAN node](../../tutorials/lora/lorawan-otaa.md)
-- [LoRaWAN nano gateway](../../tutorials/lora/lorawan-nano-gateway.md)
-{% endif %}
-{% if module=="L04" %}
-- [Sigfox](../../tutorials/sigfox/README.md)
-{% endif %}
-{% if module=="G01" %}
-- [LTE CAT-M1](../../tutorials/lte/cat_m1.md)
-- [NB-IoT](../../tutorials/lte/nb_iot.md)
-{% endif %}
-- [BLE](../../tutorials/all/ble.md)

chapter/gettingstarted/connection/instructions.md

@@ -1,234 +0,0 @@
-## Basic connection
-
-{% tabs %}
-{% tab title="Exp Board 2.0" %}
-* Look for the reset button on the module \(located at a corner of the board, next to the LED\).
-* Locate the USB connector on the expansion board.
-* Insert the module on the the expansion board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
-
-\[Picture here\]
-{% endtab %}
-
-{% tab title="Exp Board 3.0" %}
-* Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md).
-* Look for the reset button on the module \(located at a corner of the board, next to the LED\).
-* Locate the USB connector on the expansion board.
-* Insert the  module on the Expansion Board with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
-
-\[Picture here\]
-{% endtab %}
-
-{% tab title="Pysense/Pytrack/Pyscan" %}
-* Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md).
-* Look for the reset button on the MODULE module \(located at a corner of the board, next to the LED\).
-* Locate the USB connector on the Pysense/Pytrack/Pyscan.
-* Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing towards the USB connector. It should firmly click into place and the pins should now no longer be visible.
-
-\[Picture here\]
-
-Once you have completed the above steps successfully you should see the on-board LED blinking blue. This indicates the device is powered up and running.
-{% endtab %}
-
-{% tab title="USB UART Adapter" %}
-* Firstly you will need to connect power to your MODULE. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. **Note:** Do _not_ feed `3.3v` directly to the `3.3v` supply pin, this will damage the regulator.
-* The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the MODULE respectively. **Note:** Please ensure you have the signal level of the UART adapter set to `3.3v` before connecting it.
-* In order to put the MODULE into bootloader mode to update the device
-
-  firmware you will need to connect `P2` to `GND`. We recommend you connect a button between the two to make this simpler.
-
-\[Picture here\]
-{% endtab %}
-
-{% tab title="WiFi" %}
-**Note:** This method of connection is not recommended for first time users. It is possible to lock yourself out of the device, requiring a USB connection.
-
-* In order to access the MODULE via WiFi you only need to provide `3.5v` - `5.5v` on the `Vin` pin of the :
-
-\[Picture here\]
-
-* By default, when the  boots, it will create a WiFi access point with the following credentials:
-  * SSID: `MODULE-wlan`
-  * password: `www.pycom.io`
-* Once connected to this network you will be able to access the telnet and FTP servers running on the MODULE. For both of these the login details are:
-  * username: `micro`
-  * password: `python`
-{% endtab %}
-{% endtabs %}
-
-{% tabs exp2="Exp Board 2.0", exp3="Exp Board 3.0", pic="Pysense/Pytrack/Pyscan", diy="USB UART Adapter", wifi="WiFi"%}
-
-{% content "exp2" %}
-
-{% if module=="FiPy" %}
-- When using the expansion board with a {{module}}, you will need to remove the
-CTS and RTS jumpers as these interfere with communication with the cellular
-modem.
-{% endif %}
-- Look for the reset button on the module (located at a corner of the board,
-  next to the LED).
-- Locate the USB connector on the expansion board.
-- Insert the {{ module }} module on the the expansion board with the reset button
-pointing towards the USB connector. It should firmly click into place and the
-pins should now no longer be visible.
-
-<p align="center"><img src ="../img/Expansion_Board_2_{{ module }}.png" style="max-height: 400px;"></p>
-
-{% content "exp3" %}
-- Before connecting your module to an Expansion Board 3.0, you should update the firmware on the Expansion Board 3.0. Instructions on how to do this can be found [here](../../pytrackpysense/installation/firmware.md).
-{% if module=="FiPy" %}
-- When using the expansion board with a {{module}}, you will need to remove the
-CTS and RTS jumpers as these interfere with communication with the cellular
-modem.
-{% endif %}
-- Look for the reset button on the module (located at a corner of the board,
-  next to the LED).
-- Locate the USB connector on the expansion board.
-- Insert the {{ module }} module on the Expansion Board with the reset button
-pointing towards the USB connector. It should firmly click into place and the
-pins should now no longer be visible.
-
-<p align="center"><img src ="../img/Expansion_Board_3_{{ module }}.png" style="max-height: 400px;"></p>
-
-
-{% content "pic" %}
-- Before connecting your module to a Pysense/Pytrack/Pyscan board, you should update
-  the firmware on the Pysense/Pytrack/Pyscan. Instructions on how to do this can be
-  found [here](../../pytrackpysense/installation/firmware.md).
-- Look for the reset button on the {{ module }} module (located at a corner of
-the board, next to the LED).
-- Locate the USB connector on the Pysense/Pytrack/Pyscan.
-- Insert the module on the Pysense/Pytrack/Pyscan with the reset button pointing
-towards the USB connector. It should firmly click into place and the pins
- should now no longer be visible.
-
-<p align="center"><img src ="../img/Pysense_{{ module }}.png" style="max-height: 400px;"><img src ="../img/Pytrack_{{ module }}.png" style="max-height: 400px;"></p>
-
-
-Once you have completed the above steps successfully you should see the on-board
-LED blinking blue. This indicates the device is powered up and running.
-
-{% content "diy" %}
-- Firstly you will need to connect power to your {{ module }}. You will need to
-supply `3.5v`-`5.5v` to the `Vin` pin. **Note:** Do *not* feed `3.3v` directly to
-the `3.3v` supply pin, this will damage the regulator.
-- The connect the `RX` and `TX` of your USB UART to the `TX` and `RX` of the
-{{ module }} respectively. **Note:** Please ensure you have the signal level of
-the UART adapter set to `3.3v` before connecting it.
-- In order to put the {{ module }} into bootloader mode to update the device
-firmware you will need to connect `P2` to `GND`. We recommend you connect a
-button between the two to make this simpler.
-
-<p align="center"><img src ="../img/UART_{{ module }}.png" style="max-height: 400px;"></p>
-
-{% content "wifi" %}
-**Note:** This method of connection is not recommended for first time users.
-It is possible to lock yourself out of the device, requiring a USB connection.
-
- - In order to access the {{ module }} via WiFi you only need to provide `3.5v` - `5.5v` on
-the `Vin` pin of the {{ module }}:
-<p align="center"><img src ="../img/Bare_{{ module }}.png" style="max-height: 400px;"></p>
-
-- By default, when the {{ module }} boots, it will create a WiFi access point with
-the following credentials:
-  - SSID: `{{ module | lower }}-wlan`
-  - password: `www.pycom.io`
-
- - Once connected to this network you will be able to access the telnet and FTP
-servers running on the {{ module }}. For both of these the login details are:
-  - username: `micro`
-  - password: `python`
-
-{% endtabs %}
-
-## Antennas
-
-{% if module=="LoPy" or module=="SiPy" or module=="LoPy4" or module=="FiPy" %}
-{% if module=="LoPy" %}
-  {% set comm="LoRa" %}
-{% elif module=="SiPy" %}
-  {% set comm="Sigfox" %}
-{% else %}
-  {% set comm="LoRa/Sigfox" %}
-{% endif %}
-
-### {{ comm }}
-{% hint style='danger' %}
-If you intend on using the {{ comm }} connectivity of the {{ module }} you **must**
-connect a {{ comm }} antenna to your {{ module }} before trying to use
-{{ comm }} otherwise you risk damaging the device.
-{% endhint %}
-
-{% if module=="LoPy" or module=="FiPy"%}
-  {% hint style='danger' %}
-  The {{ module }} only supports LoRa on the 868MHz or 915MHz bands. It does not
-  support 433MHz. For this you will require a LoPy4.
-  {% endhint %}
-{% endif %}
-
-{% if module=="LoPy4"%}
-- Firstly you will need to connect the U.FL to SMA pig tail to the {{module}}
-using one of the two the U.FL connectors on the same side of the {{ module }}
-as the LED. The one on the left hand side is for 433MHz (LoRa only), the one of
-the right hand side is for 868MHz/915MHz (LoRa & Sigfox). **Note:** This is
-different from the LoPy.
-{% else %}
-- Firstly you will need to connect the U.FL to SMA pig tail to the {{module}}
-using the U.FL connector on the same side of the {{ module }} as the LED.
-{% endif %}
-
-<p align="center"><img src ="../img/{{comm | replace("/", "_")}}_Pigtail_{{module}}.png" style="max-height: 400px;"></p>
-
-- If you are using a pycase, you will next need to put the SMA connector through
-the antenna hole, ensuring you align the flat edge correctly, and screw down the
-connector using the provided nut.
-- Finally you will need to screw on the antenna to the SMA connector.
-<p align="center"><img src ="../img/{{comm | replace("/", "_")}}_Pigtail_ANT_{{module}}.png" style="max-height: 400px;"></p>
-{% endif %}
-
-{% if module=="GPy" or module=="FiPy" %}
-### LTE Cat-M1/NB-IoT
-If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the {{ module }}
-you **must** connect a LTE CAT-M1/NB-IoT antenna to your {{ module }} before
-trying to use LTE Cat-M1 or NB-IoT otherwise you risk damaging the device.
-
-- You will need to connect the antenna to the {{module}} using the U.FL
-connector on the
-{% if module=="GPy" %} same side of the {{ module }} as the LED.
-{% else %} under side of the {{ module }}.
-{% endif %}
-<p align="center"><img src ="../img/LTE_ANT_{{module}}.png" style="max-height: 400px;"></p>
-{% endif %}
-
-### WiFi/Bluetooth (optional)
-All Pycom modules, including the {{ module }}, come with a on-board WiFi antenna
-as well as a U.FL connector for an external antenna. The external antenna is
-optional and only required if you need better performance or are mounting the
-{{ module }} in such a way that the WiFi signal is blocked. Switching between
-the antennas is done via software, instructions for this can be found
-[here.](../../firmwareapi/pycom/network/wlan.md)
-
-<p align="center"><img src ="../img/WiFi_Pigtail_ANT_{{module}}.png" style="max-height: 400px;"></p>
-
-{% if module=="GPy" or module=="FiPy" %}
-## SIM card
-If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the {{ module }}
-you will need to insert a SIM card into your {{ module }}. It should be noted
-that the {{ module }} does not support regular LTE connectivity and you may
-require a special SIM. It is best to contact your local cellular providers for
-more information on acquiring a LTE CAT-M1/NB-IoT enabled nano SIM.
-
-<p align="center"><img src ="../img/SIM_{{ module }}.png"></p>
-
-{% endif %}
-{% if module=="LoPy" or module=="SiPy" or module=="WiPy" %}
-## Deep Sleep current issue
-
-The LoPy, SiPy, and WiPy 2.0 experience an issue where the modules maintain a
-high current consumption in deep sleep mode. This issue has been resolved in
-all newer products. The cause for this issue is the DC to DC switch mode
-converter remains in a high performance mode even when the device is in deep
-sleep. The flash memory chip also does not power down. A more detailed
-explanation can be found
-[here.](https://forum.pycom.io/topic/1022/root-causes-of-high-deep-sleep-current)
-
-{% endif %}