diff --git a/content/pymakr/toolsfeatures.md b/content/pymakr/toolsfeatures.md deleted file mode 100644 index b08869c..0000000 --- a/content/pymakr/toolsfeatures.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Tools/Features" -aliases: - - pymakr/toolsfeatures.html - - pymakr/toolsfeatures.md - - chapter/pymakr/toolsfeatures ---- - -## Console (REPL) - -MicroPython has an interactive code tool known as the REPL (Read Evaluate Print Line). The REPL allows you to run code on your device, line by line. To begin coding, go to the Pymakr Plugin Console and start typing your code. Start by making the LED change colour. - -```python - -import pycom # we need this module to control the LED - -pycom.heartbeat(False) # disable the blue blinking -pycom.rgbled(0x00ff00) # make the LED light up green in colour -``` - -You can change the colour by adjusting the hex RGB value. - -```python - -pycom.rgbled(0xff0000) # now make the LED light up red in colour -``` - -The console can be used to run any python code, also functions or loops. - -Use `print()` to output contents of variables to the console for you to read. Returned values from functions will also be displayed if they are not caught in a variable. This will not happen for code running from the main or boot files. Here you need to use `print()` to output to the console. - -{{% hint style="info" %}} -Note that after writing or pasting any indented code like a function or a while loop, the user will have to press enter up to three times to tell MicroPython the code is to be closed (this is standard MicroPython & Python behaviour). - -Also be aware that code written into the REPL is not saved after the device is powered off/on again. -{{% /hint %}} - -## Run - -To test code on a device, create a new `.py` file or open an existing one, type the desired code, save the file and then press the `Run` button. This will run the code directly onto the Pycom board and output the results of the script to the REPL. - -{{% hint style="info" %}} -Changes made to files won't be automatically uploaded to the board upon restarting or exiting the `Run` feature, as the Pycom board will not store this code. In order to push the code permanently to a device, use the `Upload` feature. -{{% /hint %}} - -## Projects - -Pymakr Plugin supports user projects, allowing for pre-configured settings such as default serial address/credentials, files to be ignored and folders to sync. - -## pymakr.conf - -Pymakr Plugin supports local project settings using a file called `pymakr.conf`. This can be used to store the default serial address of a device, which files to ignore and other settings. An example `pymakr.conf` is shown below: - -```javascript -{ - "address": "/dev/cu.usbserial-AB001234", - "username": "micro", - "password": "python", - "sync_folder": "scripts" -} -``` - -## Upload - -The Pymakr Plugins have a feature to sync and upload code to a device. This can be used for both uploading code to a device as well as testing out scripts by running them live on the device. The following steps demonstrate how to use this feature. - -To start using the `Upload` feature, ensure that a project folder has been created for the device. For example, if using the `pymakr.conf` from above, this project folder should be named `scripts`. This folder should have the following structure: - -![](/gitbook/assets/mp-filestructure.png) - -Library files should be placed into the `lib` folder, certificates into the `cert` folder and so on. The `Upload` button will take the highest level folder (currently open) and upload this to the connected Pycom device. The files will be pushed to the device in exactly the same structure as within the code editor's file directory. - -## More - -Clicking the `More` button within the Pymakr Plugin allows for some additional features. See the options below for specific functionality. - -### Get Firmware Version - -Retrieves the firmware version of the Pycom device connected to the Pymakr Plugin instance. - -### Get WiFi AP SSID - -Retrieves the default WiFi Access Point SSID of the Pycom device connected to the Pymakr Plugin instance. - -### Get Serial Ports - -Retrieves the various serial ports that are available to the Pymakr Plugin instance. - diff --git a/content/pytrackpysense/_index.md b/content/pytrackpysense/_index.md deleted file mode 100644 index 201f4b3..0000000 --- a/content/pytrackpysense/_index.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "Introduction" -aliases: - - pytrackpysense/introduction.html - - pytrackpysense/introduction.md - - chapter/pytrackpysense - - expansion3/introduction.html - - expansion3/introduction.md - - chapter/expansion3 -disable_breadcrumbs: true ---- - -In addition to the Expansion Board, Pycom also offers three additional types of sensor boards, which are ideal for quickly building a fully functioning IoT solution! Whether the application is environment sensing or asset tracking, these additional boards support a variety of sensors. New versions of the Pytrack and Pysense are now available with additional features: - -## Pytrack 2.0 X - -Pytrack 2.0 X is an improved location enabled version of the Expansion Board, intended for use in GPS applications such as asset tracking or monitoring. - -![](/gitbook/assets/pytrack20X.png) - -## New Features on Pytrack 2.0 X - -* External 6 pin connector to add new Pycom sensor range Pynodes. You can technically have upto 256 nodes connected in a daisy chain (data bus) although we are sure you would never reach that number -* SMA connector for External active / passive GPS antennas when the built-in GPS antenna needs a boost! -* circuity to enable full power down of module for hard resets without needing to put module in Deep sleep. -* safeboot button for when things go wrong - -## Pysense 2.0 X - -Pysense 2.0 X is an improved sensor packed version of the Expansion Board, intended for use in environment sensing applications such as temperature, humidity monitoring, and light sensing. - -![](/gitbook/assets/pysense20X.png) - -## New Features on Pysense 2.0 X - -* External 6 pin connector to add new Pycom sensor range Pynodes (Coming Soon!) -* A new circuity to enable full power down of module for hard resets without needing to put module in Deep sleep. -* Enhanced isolation of onboard sensors to improve reliability of sensor reporting. -* New safeboot button for when things go wrong - -## Pytrack 1 - -Pytrack is a location enabled version of the Expansion Board, intended for use in GPS applications such as asset tracking or monitoring. - -![](/gitbook/assets/pytrack.png) - -### Features & Hardware - -The Pytrack is has a number of features including GPS, 3-Axis Accelerometer and Battery Charger. See the list below for detailed specifics about each sensor, including datasheets. - -* Serial USB -* 3-Axis Accelerometer ([LIS2HH12](apireference/pytrack.md#3-axis-accelerometer-lis-2-hh-12)) -* Battery Charger (BQ24040 with JST connector) -* GPS and GLONASS ([L76-L](apireference/pytrack.md#gps-with-glonass-quectel-l-76-l-gnss)) -* MicroSD Card Reader - -All of the included sensors are connected to the Pycom device via the I2C interface. These pins are located at `P22` (SDA) and `P21` (SCL). - -You can find the datasheet and more info here: {{% refname "../datasheets/boards/pytrack.md" %}} - -## Pysense 1 - -Pysense is a sensor packed version of the Expansion Board, intended for use in environment sensing applications such as temperature, humidity monitoring, and light sensing. - -![](/gitbook/assets/pysense.png) - -### Features & Hardware - -The Pysense is packed with a number of sensors and hardware, see the list below for detailed specifics about each sensor, including datasheets. - -* Serial USB -* 3-Axis Accelerometer ([LIS2HH12](apireference/pysense.md#3-axis-accelerometer-lis-2-hh-12)) -* Battery Charger (BQ24040 with JST connector) -* Digital Ambient Light Sensor ([LTR-329ALS-01](apireference/pysense.md#digital-ambient-light-sensor-ltr-329-als-01)) -* Humidity and Temperature Sensor ([SI7006-A20](apireference/pysense.md#humidity-and-temperature-sensor-si-7006-a20)) -* Barometric Pressure Sensor with Altimeter ([MPL3115A2](apireference/pysense.md#barometric-pressure-sensor-with-altimeter-mpl-3115-a2)) -* MicroSD Card Reader - -All of the included sensors are connected to the Pycom device via the I2C interface. These pins are located at `GPI09` (SDA) and `GPI08` (SCL). - -You can find the datasheet and more info here: {{% refname "../datasheets/boards/pysense.md" %}} - -## Pyscan - -Pyscan is a RFID-NFC enabled version of the Expansion Board, intended for use in scanning applications, such as RFID/NFC readers. - -![](/gitbook/assets/pyscan-new.png) - -### Features & Hardware - -The Pyscan is packed with a number of sensors and hardware, see the list below for detailed specifics about each sensor, including datasheets. - -* 3-Axis Accelerometer ([LIS2HH12](apireference/pyscan.md#3-axis-accelerometer-lis-2-hh-12)) -* Digital Ambient Light Sensor ([LTR-329ALS-01](apireference/pyscan.md#digital-ambient-light-sensor-ltr-329-als-01)) -* RFID-NFC Chip ([MFRC63002HN](apireference/pyscan.md#pyscan-nfc-library-mfrc-6300)) -* Serial USB -* Battery Charger (BQ24040 with JST connector) -* MicroSD Card Reader -* Ultra low power operation (~1uA in deep sleep) - -All of the included sensors are connected to the Pycom device via the I2C interface. These pins are located at `P22` (SDA) and `P21` (SCL). - -You can find the datasheet and more info here: {{% refname "../datasheets/boards/pyscan.md" %}} diff --git a/content/pytrackpysense/introduction.md b/content/pytrackpysense/introduction.md deleted file mode 100644 index dffaafc..0000000 --- a/content/pytrackpysense/introduction.md +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "Introduction" -aliases: - - pytrackpysense/introduction.html - - pytrackpysense/introduction.md - - chapter/pytrackpysense ---- - -In addition to the Expansion Board, Pycom also offers three additional types of sensor boards, which are ideal for quickly building a fully functioning IoT solution! Whether the application is environment sensing or asset tracking, these additional boards support a variety of sensors. New versions of the Pytrack and Pysense are now available with additional features: - -## Pytrack 2.0 X - -Pytrack 2.0 X is an improved location enabled version of the Expansion Board, intended for use in GPS applications such as asset tracking or monitoring. - -![](/gitbook/assets/pytrack20X.png) - -## New Features on Pytrack 2.0 X - -* External 6 pin connector to add new Pycom sensor range Pynodes. You can technically have upto 256 nodes connected in a daisy chain (data bus) although we are sure you would never reach that number -* SMA connector for External active / passive GPS antennas when the built-in GPS antenna needs a boost! -* circuity to enable full power down of module for hard resets without needing to put module in Deep sleep. -* safeboot button for when things go wrong - -## Pysense 2.0 X - -Pysense 2.0 X is an improved sensor packed version of the Expansion Board, intended for use in environment sensing applications such as temperature, humidity monitoring, and light sensing. - -![](/gitbook/assets/pysense20X.png) - -## New Features on Pysense 2.0 X - -* External 6 pin connector to add new Pycom sensor range Pynodes (Coming Soon!) -* A new circuity to enable full power down of module for hard resets without needing to put module in Deep sleep. -* Enhanced isolation of onboard sensors to improve reliability of sensor reporting. -* New safeboot button for when things go wrong - -## Pytrack 1 - -Pytrack is a location enabled version of the Expansion Board, intended for use in GPS applications such as asset tracking or monitoring. - -![](/gitbook/assets/pytrack-new.png) - -### Features & Hardware - -The Pytrack is has a number of features including GPS, 3-Axis Accelerometer and Battery Charger. See the list below for detailed specifics about each sensor, including datasheets. - -* Serial USB -* 3-Axis Accelerometer ([LIS2HH12](apireference/pytrack.md#3-axis-accelerometer-lis-2-hh-12)) -* Battery Charger (BQ24040 with JST connector) -* GPS and GLONASS ([L76-L](apireference/pytrack.md#gps-with-glonass-quectel-l-76-l-gnss)) -* MicroSD Card Reader - -All of the included sensors are connected to the Pycom device via the I2C interface. These pins are located at `P22` (SDA) and `P21` (SCL). - -You can find the datasheet and more info here: {{% refname "../datasheets/boards/pytrack.md" %}} - -## Pysense 1 - -Pysense is a sensor packed version of the Expansion Board, intended for use in environment sensing applications such as temperature, humidity monitoring, and light sensing. - -![](/gitbook/assets/pysense.png) - -### Features & Hardware - -The Pysense is packed with a number of sensors and hardware, see the list below for detailed specifics about each sensor, including datasheets. - -* Serial USB -* 3-Axis Accelerometer ([LIS2HH12](apireference/pysense.md#3-axis-accelerometer-lis-2-hh-12)) -* Battery Charger (BQ24040 with JST connector) -* Digital Ambient Light Sensor ([LTR-329ALS-01](apireference/pysense.md#digital-ambient-light-sensor-ltr-329-als-01)) -* Humidity and Temperature Sensor ([SI7006-A20](apireference/pysense.md#humidity-and-temperature-sensor-si-7006-a20)) -* Barometric Pressure Sensor with Altimeter ([MPL3115A2](apireference/pysense.md#barometric-pressure-sensor-with-altimeter-mpl-3115-a2)) -* MicroSD Card Reader - -All of the included sensors are connected to the Pycom device via the I2C interface. These pins are located at `GPI09` (SDA) and `GPI08` (SCL). - -You can find the datasheet and more info here: {{% refname "../datasheets/boards/pysense.md" %}} - -## Pyscan - -Pyscan is a RFID-NFC enabled version of the Expansion Board, intended for use in scanning applications, such as RFID/NFC readers. - -![](/gitbook/assets/pyscan-new.png) - -### Features & Hardware - -The Pyscan is packed with a number of sensors and hardware, see the list below for detailed specifics about each sensor, including datasheets. - -* 3-Axis Accelerometer ([LIS2HH12](apireference/pyscan.md#3-axis-accelerometer-lis-2-hh-12)) -* Digital Ambient Light Sensor ([LTR-329ALS-01](apireference/pyscan.md#digital-ambient-light-sensor-ltr-329-als-01)) -* RFID-NFC Chip ([MFRC63002HN](apireference/pyscan.md#pyscan-nfc-library-mfrc-6300)) -* Serial USB -* Battery Charger (BQ24040 with JST connector) -* MicroSD Card Reader -* Ultra low power operation (~1uA in deep sleep) - -All of the included sensors are connected to the Pycom device via the I2C interface. These pins are located at `P22` (SDA) and `P21` (SCL). - -You can find the datasheet and more info here: - -{{% refname "../datasheets/boards/pyscan.md" %}}