From 3eb0d726f887894a67d915957db3fe6dbdbfa0ef Mon Sep 17 00:00:00 2001 From: gijsio <67470426+gijsio@users.noreply.github.com> Date: Wed, 22 Jul 2020 16:31:24 +0200 Subject: [PATCH] fixed several typos, removed old files fixed layout --- content/datasheets/_index.md | 6 +- content/datasheets/boards/deepsleep/README.md | 26 --- content/gettingstarted/_index.md | 9 +- content/gettingstarted/connection/README.md | 17 -- content/gettingstarted/connection/_index.md | 18 --- content/gettingstarted/connection/fipy.md | 153 ------------------ content/gettingstarted/connection/gpy.md | 121 -------------- content/gettingstarted/connection/lopy.md | 141 ---------------- content/gettingstarted/connection/lopy4.md | 137 ---------------- content/gettingstarted/connection/sipy.md | 133 --------------- content/gettingstarted/connection/wipy.md | 130 --------------- content/gettingstarted/hardware/_index.md | 0 content/gettingstarted/registration/_index.md | 3 +- content/products/_index.md | 2 +- content/tutorials/expansionboards/_index.md | 1 + themes/doc-theme/static/css/vuetify.css | 6 +- 16 files changed, 15 insertions(+), 888 deletions(-) delete mode 100644 content/datasheets/boards/deepsleep/README.md delete mode 100644 content/gettingstarted/connection/README.md delete mode 100644 content/gettingstarted/connection/_index.md delete mode 100644 content/gettingstarted/connection/fipy.md delete mode 100644 content/gettingstarted/connection/gpy.md delete mode 100644 content/gettingstarted/connection/lopy.md delete mode 100644 content/gettingstarted/connection/lopy4.md delete mode 100644 content/gettingstarted/connection/sipy.md delete mode 100644 content/gettingstarted/connection/wipy.md delete mode 100644 content/gettingstarted/hardware/_index.md diff --git a/content/datasheets/_index.md b/content/datasheets/_index.md index 13a239f..1c029f2 100644 --- a/content/datasheets/_index.md +++ b/content/datasheets/_index.md @@ -28,11 +28,13 @@ The follow pages contain all information relating to each product, for example: - [Deepsleep](datasheets/oem/deepsleep.md) ## Expansion boards -- [Expansion 2](/datasheets/expansionboards/expansion2.md) -- [Expansion 3](/datasheets/expansionboards/expansion3.md) - [Pygate](/datasheets/expansionboards/pygate.md) - [Pysense](/datasheets/expansionboards/pysense.md) - [Pysense 2.0 X](/datasheets/expansionboards/pysense.md) - [Pytrack](/datasheets/expansionboards/pytrack.md) - [Pysense 2.0 X](/datasheets/expansionboards/pysense.md) +- [Pyscan](/datasheets/expansionboards/pyscan.md) +- [Expansion 2](/datasheets/expansionboards/expansion2.md) +- [Expansion 3](/datasheets/expansionboards/expansion3.md) + diff --git a/content/datasheets/boards/deepsleep/README.md b/content/datasheets/boards/deepsleep/README.md deleted file mode 100644 index 45ab43d..0000000 --- a/content/datasheets/boards/deepsleep/README.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Deep Sleep Shield" -aliases: - - product-info/boards/deepsleep - - chapter/datasheets/boards/deepsleep ---- - -The schematic of the Deep Sleep Shield is available as a PDF File. - - Deep Sleep Schematic - -## Pinout - -The pinout of the Deep Sleep Shield is available as a PDF File - - Deep Sleep Pinout - - -![](/gitbook/assets/deepsleep-pinout.png) - -{{% hint style="info" %}} -To correctly connect a WiPy 2.0, LoPy or SiPy to the Deep Sleep Shield, align the white triangle on the Shield with the Pycom device's LED. Once the Pycom device is seated with the Deep Sleep Shield, this can then be connected to the Expansion Board -{{% /hint %}} - -![](/gitbook/assets/deepsleep-image-1.jpg) - diff --git a/content/gettingstarted/_index.md b/content/gettingstarted/_index.md index ae073c4..b56ef2e 100644 --- a/content/gettingstarted/_index.md +++ b/content/gettingstarted/_index.md @@ -51,17 +51,12 @@ Now that you have a connected module and all the required software installed it In this first example, we will make the on-board RGB LED flash different colors. ### Creating a project in Pymakr -1. Firstly you will need to create a new, empty, directory on your computer. +1. Firstly you will need to create a new, empty, directory on your computer. For this example we will create one called `RGB-Blink`. - For this example we will create one called `RGB-Blink`. - -2. Next you will need to open either Atom or Visual Studio Code depending on - - which you setup previously. +2. Next you will need to open either Atom or Visual Studio Code depending on which you setup previously. 3. Once the text editor has loaded you will need to click `File` > `Open`, and open the directory you created in step 1 -{{% hint style="info" %}} If you are using Atom, it is important to check at this point that Atom has successfully identified the project. The name of the directory you created in step 1 (`RGB-Blink` in this case) should be shown in the Pymakr pane like so: ![](/gitbook/assets/atom_project.png) diff --git a/content/gettingstarted/connection/README.md b/content/gettingstarted/connection/README.md deleted file mode 100644 index 6c9702a..0000000 --- a/content/gettingstarted/connection/README.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Hardware Setup" -aliases: - - chapter/gettingstarted/hardwaresetup ---- - -This chapter will show you how to connect your Pycom module. For each device there are detailed instructions on how to connect your module to one of our base boards, a USB UART adapter, or WiFi as well as the different antennas you might need to connect. Please select your module below to be taken to the appropriate guide. - -{{% refname "lopy.md" %}} - -{{% refname "sipy.md" %}} - -{{% refname "gpy.md" %}} - -{{% refname "fipy.md" %}} - -{{% refname "wipy.md" %}} diff --git a/content/gettingstarted/connection/_index.md b/content/gettingstarted/connection/_index.md deleted file mode 100644 index 4586e69..0000000 --- a/content/gettingstarted/connection/_index.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Hardware Setup" -aliases: ---- - -This chapter of the documentation will show you how to connect you Pycom module. For each device, there are detailed instructions on how to connect your module to one of our base boards, a USB UART adapter, or WiFi as well as what antennas you might need to connect. Please select your module below to be taken to the appropriate guide. - -{{% refname "lopy.md" %}} - -{{% refname "lopy4.md" %}} - -{{% refname "sipy.md" %}} - -{{% refname "gpy.md" %}} - -{{% refname "fipy.md" %}} - -{{% refname "wipy.md" %}} diff --git a/content/gettingstarted/connection/fipy.md b/content/gettingstarted/connection/fipy.md deleted file mode 100644 index 1b46d86..0000000 --- a/content/gettingstarted/connection/fipy.md +++ /dev/null @@ -1,153 +0,0 @@ ---- -title: "FiPy" -aliases: - - gettingstarted/connection/fipy.html - - gettingstarted/connection/fipy.md - - chapter/gettingstarted/connection/fipy - - gettingstarted/fipy.html ---- - -## Basic connection - -
- - - Exp Board 3.0 - Exp Board 2.0 - Pytrack/Pysense/Pyscan - USB UART Adapter - WiFi - - - -
    -
  • 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.
    • -
  • When using the expansion board with a FiPy, you will need to remove the CTS and RTS jumpers as these interfere with communication with the cellular modem.
    • -
  • 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 FiPy 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.
    • -
- - - - -
    -
  • When using the expansion board with a FiPy, you will need to remove the CTS and RTS jumpers as these interfere with communication with the cellular modem.
    • -
  • 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 FiPy 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.
    • -
- - - - - -
-
    -
  • 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.
    • -
  • Look for the reset button on the FiPy 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.
    • -
- - -
- - -
-
    -
  • Firstly you will need to connect power to your FiPy. You will need to supply 3.5v-5.5v to the Vin pin. - - 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 FiPy respectively. - - Please ensure you have the signal level of the UART adapter set to 3.3v before connecting it.
    • - -
  • In order to put the FiPy 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.
    • - -
- - -
- - - -
-

- 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 FiPy via WiFi you only need to provide 3.5v - 5.5v on the Vin pin of the FiPy: - - - -
    • - -
  • By default, when the FiPy boots, it will create a WiFi access point with the following credentials: -
      -
    • SSID: fipy-wlan
      • -
    • password: www.pycom.io
      • -
    -
    • -
  • Once connected to this network you will be able to access the telnet and FTP servers running on the FiPy. For both of these the login details are: - -
      -
    • username: micro
      • -
    • password: python
      • -
    - -
    • -
-
- - - -
- - -## Antennas - -### Lora/Sigfox - -{{% hint style="danger" %}} -If you intend on using the LoRa/Sigfox connectivity of the FiPy you **must** connect a LoRa/Sigfox antenna to your FiPy before trying to use LoRa/Sigfox otherwise you risk damaging the device. -{{% /hint %}} - -{{% hint style="info" %}} -The FiPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4. -{{% /hint %}} - -* Firstly, you will need to connect the U.FL to SMA pig tail to the FiPy using the U.FL connector on the same side of the FiPy as the LED. - -![](/gitbook/assets/lora_sigfox_pigtail_fipy.png) - -* 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. - -![](/gitbook/assets/lora_sigfox_pigtail_ant_fipy.png) - -### LTE Cat-M1/NB-IoT - -{{% hint style="danger" %}} -If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you **must** connect a LTE CAT-M1/NB-IoT antenna to your FiPy before trying to use LTE Cat-M1 or NB-IoT otherwise you risk damaging the device. -{{% /hint %}} - -* You will need to connect the antenna to the FiPy using the U.FL connector on the under side of the FiPy. - -![](/gitbook/assets/lte_ant_fipy.png) - -### WiFi/Bluetooth (optional) - -All Pycom modules, including the FiPy, 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 FiPy 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) - -![](/gitbook/assets/wifi_pigtail_ant_fipy.png) - -### SIM card - -If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the FiPy you will need to insert a SIM card into your FiPy. It should be noted that the FiPy 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. - -![](/gitbook/assets/sim_fipy.png) diff --git a/content/gettingstarted/connection/gpy.md b/content/gettingstarted/connection/gpy.md deleted file mode 100644 index 26ee0fc..0000000 --- a/content/gettingstarted/connection/gpy.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: "GPy" -aliases: - - gettingstarted/connection/gpy.html - - gettingstarted/connection/gpy.md - - chapter/gettingstarted/connection/gpy - - gettingstarted/gpy.html ---- - -## Basic connection - - -
- - Exp Board 3.0 - Exp Board 2.0 - Pytrack/Pysense/Pyscan - USB UART Adapter - WiFi - - -
    -
  • 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
    • -
  • 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 GPy 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.
    • - -
- - -
    -
  • 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 GPy 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. -
- - - - - -
    -
  • 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 -
  • Look for the reset button on the GPy 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.
    • - - - -
- - - -
    -
  • Firstly you will need to connect power to your GPy. You will need to supply 3.5v-5.5v to the Vin pin. - 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 GPy respectively. - Please ensure you have the signal level of the UART adapter set to 3.3v before connecting it.
    • - - -
  • In order to put the GPy 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.
    • -
- - - - - 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 GPy via WiFi you only need to provide - 3.5v - 5.5v on the Vin pin of the GPy: - -
    • -
  • By default, when the GPy boots, it will create a WiFi access point with the following credentials: -
      -
    • SSID:gpy-wlan
      • -
    • password: www.pycom.io
      • -
    -
    • -
  • Once connected to this network you will be able to access the telnet and FTP servers running on the GPy. For both of these the login details are: -
      -
    • username: micro
      • -
    • password: python
      • - -
    -
    • -
- - - -
- -## Antennas - -### LTE Cat-M1/NB-IoT - -{{% hint style="danger" %}} -If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you **must** connect a LTE CAT-M1/NB-IoT antenna to your GPy before trying to use LTE Cat-M1 or NB-IoT otherwise you risk damaging the device. -{{% /hint %}} - -* You will need to connect the antenna to the GPy using the U.FL connector on the same side of the GPy as the LED. - -![](/gitbook/assets/lte_ant_gpy.png) - -### WiFi/Bluetooth (optional) - -All Pycom modules, including the GPy, 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 GPy 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) - -![](/gitbook/assets/wifi_pigtail_ant_gpy.png) - -### SIM card - -If you intend on using the LTE CAT-M1 or NB-IoT connectivity of the GPy you will need to insert a SIM card into your GPy. It should be noted that the GPy 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. - -![](/gitbook/assets/sim_gpy.png) diff --git a/content/gettingstarted/connection/lopy.md b/content/gettingstarted/connection/lopy.md deleted file mode 100644 index 533f3f0..0000000 --- a/content/gettingstarted/connection/lopy.md +++ /dev/null @@ -1,141 +0,0 @@ ---- -title: "LoPy" -aliases: - - gettingstarted/connection/lopy.html - - gettingstarted/connection/lopy.md - - chapter/gettingstarted/connection/lopy - - gettingstarted/lopy.html ---- - -## Basic connection -
- - Exp Board 3.0 - Exp Board 2.0 - Pytrack/Pysense/Pyscan - USB UART Adapter - WiFi - - - -
    -
  • 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 -
    • -
  • 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 LoPy 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.
    • -
- - - - - -
    -
  • 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 LoPy 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.
    • -
- - - - - -
    -
  • 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.
    • -
  • Look for the reset button on the LoPy 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. - - -
    • -
- - - -
    -
  • Firstly you will need to connect power to your LoPy. You will need to supply `3.5v`-`5.5v` to the `Vin` pin. - - 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 LoPy respectively. - - Please ensure you have the signal level of the UART adapter set to 3.3v before connecting it. -
    • -
  • - In order to put the LoPy 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. -
    • -
- - - - - - 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 LoPy via WiFi you only need to provide - 3.5v - 5.5v on the Vin pin of the LoPy: - -
    • - -
  • - By default, when the LoPy boots, it will create a WiFi access point with the following credentials: -
      -
    • SSID: lopy-wlan
      • -
    • password: www.pycom.io
      • -
    -
    • - -
  • Once connected to this network you will be able to access the telnet and FTP servers running on the LoPy. For both of these the login details are: -
      -
    • username: micro
      • -
    • password: python
      • -
    -
    • -
- - - -
- - -## Antennas - -### Lora antenna - -{{% hint style="danger" %}} -If you intend on using the LoRa connectivity of the LoPy you **must** connect a LoRa antenna to your LoPy before trying to use LoRa otherwise you risk damaging the device. -{{% /hint %}} - -{{% hint style="danger" %}} -The LoPy only supports LoRa on the 868MHz or 915MHz bands. It does not support 433MHz. For this you will require a LoPy4. -{{% /hint %}} - -* Firstly you will need to connect the U.FL to SMA pig tail to the LoPy using the U.FL connector on the same side of the LoPy as the LED. - -![](/gitbook/assets/lora_pigtail_lopy.png) - -* 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. - -![](/gitbook/assets/lora_pigtail_ant_lopy.png) - -### WiFi/Bluetooth antenna (optional) - -All Pycom modules, including the LoPy, 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 LoPy 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) - -![](/gitbook/assets/wifi_pigtail_ant_lopy.png) - -## 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) diff --git a/content/gettingstarted/connection/lopy4.md b/content/gettingstarted/connection/lopy4.md deleted file mode 100644 index 78d4597..0000000 --- a/content/gettingstarted/connection/lopy4.md +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: "LoPy 4" -aliases: - - gettingstarted/connection/lopy4.html - - gettingstarted/connection/lopy4.md - - chapter/gettingstarted/connection/lopy4 - - gettingstarted/lopy4.html ---- - -## Basic connection - -
- - Exp Board 3.0 - Exp Board 2.0 - Pytrack/Pysense/Pyscan - USB UART Adapter - WiFi - - - -
    -
  • 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 -
    • -
  • 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 LoPy4 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. -
    • -
- - - - -
    -
  • 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 LoPy4 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.
    • -
- - - - -
    -
  • 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.
    • -
  • Look for the reset button on the LoPy4 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.
    • -
- - - - - - - - -
    -
  • Firstly you will need to connect power to your LoPy4. You will need to supply 3.5v-5.5v to the Vin pin. - - 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 LoPy4 respectively. - - Please ensure you have the signal level of the UART adapter set to - 3.3v before connecting it.
    • - -
  • In order to put the LoPy4 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. -
    • -
- - - - - - - - - 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 LoPy4 via WiFi you only need to provide - 3.5v - 5.5v on the Vin pin of the LoPy4: - - -
    • -
  • By default, when the LoPy4 boots, it will create a WiFi access point with the following credentials: -
      -
    • SSID: lopy4-wlan -
    • password: www.pycom.io -
    -
    • -
  • Once connected to this network you will be able to access the telnet and FTP servers running on the LoPy4. For both of these the login details are: -
      -
    • username: micro -
    • password: python -
    -
    • -
- - - -
- -## Antennas - -### Lora/Sigfox - -{{% hint style="danger" %}} -If you intend on using the LoRa/Sigfox connectivity of the LoPy4 you **must** connect a LoRa/Sigfox antenna to your LoPy4 before trying to use LoRa/Sigfox otherwise you risk damaging the device. -{{% /hint %}} - -* Firstly you will need to connect the U.FL to SMA pig tail to the LoPy4 using one of the two the U.FL connectors on the same side of the LoPy4 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. - -![](/gitbook/assets/lora_sigfox_pigtail_lopy4.png) - -* 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. - -![](/gitbook/assets/lora_sigfox_pigtail_ant_lopy4.png) - -{{% hint style="danger" %}} -Since the LoRa chip only runs on one frequency band at a time you only need to connect an antenna to the appropriate U.FL connecor. You should be supplied with a the antenna that suits the band you intend using. -{{% /hint %}} - -### WiFi/Bluetooth (optional) - -All Pycom modules, including the LoPy4, 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 LoPy4 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) - -![](/gitbook/assets/wifi_pigtail_ant_lopy4.png) diff --git a/content/gettingstarted/connection/sipy.md b/content/gettingstarted/connection/sipy.md deleted file mode 100644 index a3dddf9..0000000 --- a/content/gettingstarted/connection/sipy.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -title: "SiPy" -aliases: - - gettingstarted/connection/sipy.html - - gettingstarted/connection/sipy.md - - chapter/gettingstarted/connection/sipy - - gettingstarted/sipy.html ---- - -## Basic connection - -
- - Exp Board 3.0 - Exp Board 2.0 - Pytrack/Pysense/Pyscan - USB UART Adapter - WiFi - - - - - -
    -
  • 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 -
  • 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 SiPy 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. - - -
- - -
    -
  • 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 SiPy 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. - - -
- - - - - -
    -
  • 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
    • -
  • Look for the reset button on the SiPy 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. - - -
    • -
- - -
    -
  • Firstly you will need to connect power to your SiPy. You will need to supply -3.5v-5.5v to the Vin pin. - -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 SiPy respectively. - -Please ensure you have the signal level of the UART adapter set to -3.3v before connecting it. - - -
  • In order to put the SiPy 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. - - -
- - -**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 SiPy via WiFi you only need to provide 3.5v - 5.5v on the Vin pin of the SiPy: - - -
    • -
  • By default, when the SiPy boots, it will create a WiFi access point with the following credentials: -
      -
    • SSID: sipy-wlan -
    • password: www.pycom.io -
    -
    • -
  • Once connected to this network you will be able to access the telnet and FTP servers running on the SiPy. For both of these the login details are: -
      -
    • username: micro -
    • password: python
      • -
    -
- - - - -
- ---- - -## Antennas - -### Sigfox - -{{% hint style="danger" %}} -If you intend on using the Sigfox connectivity of the SiPy you **must** connect a Sigfox antenna to your SiPy before trying to use Sigfox otherwise you risk damaging the device. -{{% /hint %}} - -* Firstly you will need to connect the U.FL to SMA pig tail to the SiPy using the U.FL connector on the same side of the SiPy as the LED. - -![](/gitbook/assets/sigfox_pigtail_sipy.png) - -* 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. - -![](/gitbook/assets/sigfox_pigtail_ant_sipy.png) - -### WiFi/Bluetooth (optional) - -All Pycom modules, including the FiPy, 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 FiPy 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) - -![](/gitbook/assets/wifi_pigtail_ant_sipy.png) - -## 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) diff --git a/content/gettingstarted/connection/wipy.md b/content/gettingstarted/connection/wipy.md deleted file mode 100644 index 27006e5..0000000 --- a/content/gettingstarted/connection/wipy.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: "WiPy" -aliases: - - gettingstarted/connection/wipy.html - - gettingstarted/connection/wipy.md - - chapter/gettingstarted/connection/wipy - - gettingstarted/wipy.html ---- - -## Basic connection - -
- - Exp Board 3.0 - Exp Board 2.0 - Pytrack/Pysense/Pyscan - USB UART Adapter - WiFi - - - - -
    -
  • 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.
    • -
  • 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 WiPy 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.
    • - - - -
- - - - -
    -
  • 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 WiPy 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. -
    • -
- - - - - -
    -
  • 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.
    • -
  • Look for the reset button on the WiPy 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. - - -
    • -
- - - - - - -
    -
  • Firstly you will need to connect power to your WiPy. You will need to supply -3.5v-5.5v to the Vin pin. - -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 WiPy respectively. - -Please ensure you have the signal level of the UART adapter set to 3.3v before connecting it. -
    • -
  • In order to put the WiPy 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. -
    • -
- - - - - - 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 WiPy via WiFi you only need to provide 3.5v - 5.5v on the Vin pin of the WiPy: - -
  • By default, when the WiPy boots, it will create a WiFi access point with the following credentials: -
      -
    • SSID: wipy-wlan
      • -
    • password: www.pycom.io
      • -
    -
  • Once connected to this network you will be able to access the telnet and FTP servers running on the WiPy. For both of these the login details are: -
      -
    • username: micro
      • -
    • password: python
      • - -
    - - - - -
- ---- - -## Antennas - -### WiFi/Bluetooth (optional) - -All Pycom modules, including the WiPy, 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 WiPy 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) - -![](/gitbook/assets/wifi_pigtail_ant_wipy.png) - -## 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) - -## WiPy 2.0 vs WiPy 3.0 - -The WiPy 3.0 is an upgraded version of the WiPy 2.0 with the following changes: - -* The FLASH has been upgraded from 4MB to 8MB. -* The RAM has been upgraded from 512KB to 4MB. -* The deepsleep current consumption issue has been fixed -* The antenna select pin has moved to GPIO21 (P12) diff --git a/content/gettingstarted/hardware/_index.md b/content/gettingstarted/hardware/_index.md deleted file mode 100644 index e69de29..0000000 diff --git a/content/gettingstarted/registration/_index.md b/content/gettingstarted/registration/_index.md index a7485d0..bcc3e06 100644 --- a/content/gettingstarted/registration/_index.md +++ b/content/gettingstarted/registration/_index.md @@ -11,5 +11,6 @@ Some of our devices require registration before you can utilise specific feature ## Other * [SigFox](/gettingstarted/registration/sigfox/) * [Cellular](/gettinsgtarted/registration/cellular/) -> **Not all Pycom devices require activation**; most features work immediately out of the box! + +>**Not all Pycom devices require activation**; most features work immediately out of the box! diff --git a/content/products/_index.md b/content/products/_index.md index af2950c..6dadc70 100644 --- a/content/products/_index.md +++ b/content/products/_index.md @@ -50,7 +50,7 @@ Below you will find tables of all Pycom products. These tables illustrate the fu | Accessory | Expansionboard | Pygate | Pytrack / Pysense | Battery Size | | :--- | :--- | :--- | :--- | :--- | -[Pycase](https://pycom.io/product/pycase-clear/) | ✔ | | | small | +[Pycase](https://pycom.io/product/pycase-clear/) | ✔ | #10004; | | small | [Pygate case](https://pycom.io/product/pygate-case/) | ✔ | ✔ | | tiny | [Small IP67 Case](https://pycom.io/product/ip67-case-for-pysense-pytrack/) | | | ✔| 18650 | [Universal IP76 Case](https://pycom.io/product/universal-ip67-case/) | ✔ | ✔ | ✔| 18650 | \ No newline at end of file diff --git a/content/tutorials/expansionboards/_index.md b/content/tutorials/expansionboards/_index.md index 17242d6..23fa7c0 100644 --- a/content/tutorials/expansionboards/_index.md +++ b/content/tutorials/expansionboards/_index.md @@ -9,6 +9,7 @@ disable_breadcrumbs: true >Note: Before using the pysense and pytrac boards, check the [GitHub](https://github.com/pycom/pycom-libraries) for the latest version of the libraries. Make a folder inside your project folder and call it `lib`. Then, copy the appropiate libraries from the github repository to the folder. Always copy the `pysense.py` or `pytrack.py` and `pycoproc.py` files if you want to use the boards' functions + * [Pygate](../expansionboards/pygate/) * [Pysense](../expansionboards/pysense/) * [Pysense 2.0 X](../expansionboards/pysense2/) diff --git a/themes/doc-theme/static/css/vuetify.css b/themes/doc-theme/static/css/vuetify.css index 64274ae..187be55 100644 --- a/themes/doc-theme/static/css/vuetify.css +++ b/themes/doc-theme/static/css/vuetify.css @@ -2246,7 +2246,7 @@ samp { } b, strong { - font-weight: bolder; /* Correct style set to `bold` in Edge 12+, Safari 6.2+, and Chrome 18+ */ + font-weight: bold; /* Correct style set to `bold` in Edge 12+, Safari 6.2+, and Chrome 18+ */ } dfn { font-style: italic; /* Address styling not present in Safari and Chrome */ @@ -2756,6 +2756,10 @@ blockquote { font-weight: 300; background-color:rgba(0,128,0,0.7); border-radius: 3px; + margin-bottom: 5px; +} +blockquote > p { + margin-bottom:0px; } code, kbd {