diff --git a/.project b/.project new file mode 100644 index 0000000..0ddfeaf --- /dev/null +++ b/.project @@ -0,0 +1,11 @@ + + + pycom-documentation + + + + + + + + diff --git a/content/advance/downgrade.md b/content/advance/downgrade.md index 9d133e8..40472b3 100644 --- a/content/advance/downgrade.md +++ b/content/advance/downgrade.md @@ -43,7 +43,7 @@ As of version `1.12.0.b0` of the firmware update tool, you can now provide a `.t When you start the update tool you will see the following screen: -![](/gitbook/assets/downgrade_gui%20%281%29.png) +![](/gitbook/assets/downgrade_gui.png) When you tick the `Flash from local file` option, an address bar will appear. Click the `...` button and locate the `.tar(.gz)` file with the firmware you wish to flash to your device. From this point the updater will behave just like a regular update but using the local file instead of downloading the latest. diff --git a/content/datasheets/boards/deepsleep/README.md b/content/datasheets/boards/deepsleep/README.md index f766154..45ab43d 100644 --- a/content/datasheets/boards/deepsleep/README.md +++ b/content/datasheets/boards/deepsleep/README.md @@ -16,7 +16,7 @@ The pinout of the Deep Sleep Shield is available as a PDF File Deep Sleep Pinout -![](/gitbook/assets/deepsleep-pinout%20%281%29.png) +![](/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 diff --git a/content/datasheets/boards/deepsleep/_index.md b/content/datasheets/boards/deepsleep/_index.md index f9f1fe5..3eb88c2 100644 --- a/content/datasheets/boards/deepsleep/_index.md +++ b/content/datasheets/boards/deepsleep/_index.md @@ -14,7 +14,7 @@ The pinout of the Deep Sleep Shield is available as a PDF File Deep Sleep Pinout -![](/gitbook/assets/deepsleep-pinout%20%281%29.png) +![](/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 LED of the Pycom Device. Once the Pycom Device is seated onto the Deep Sleep Shield, this can then be connected to the Expansion Board diff --git a/content/datasheets/oem/l01_reference.md b/content/datasheets/oem/l01_reference.md index 1d9dfdd..286cf3d 100644 --- a/content/datasheets/oem/l01_reference.md +++ b/content/datasheets/oem/l01_reference.md @@ -7,7 +7,7 @@ aliases: - chapter/datasheets/oem/l01_reference --- -![](/gitbook/assets/l01-reference%20%281%29.png) +![](/gitbook/assets/l01-reference.png) The L01 OEM reference board is a reference design suitable for the L01 as well as the W01. It makes it possible to have a single PCB design that can accommodate both of the OEM modules. diff --git a/content/datasheets/oem/universal_reference.md b/content/datasheets/oem/universal_reference.md index b5a9b24..42b3ad0 100644 --- a/content/datasheets/oem/universal_reference.md +++ b/content/datasheets/oem/universal_reference.md @@ -7,7 +7,7 @@ aliases: - chapter/datasheets/oem/universal_reference --- -![](/gitbook/assets/universal_reference%20%281%29.png) +![](/gitbook/assets/universal_reference.png) The universal OEM reference board is a reference design suitable for the W01, L01, L04 and G01 OEM modules, making it possible to have a single PCB design that can accommodate all of our OEM modules. diff --git a/content/gettingstarted/_index.md b/content/gettingstarted/_index.md index e5f472f..a93b3ee 100644 --- a/content/gettingstarted/_index.md +++ b/content/gettingstarted/_index.md @@ -12,7 +12,7 @@ disable_breadcrumbs: true So, you've decided to order a Pycom development module. Firstly we would like to congratulate you in making an excellent decision. If you haven't yet placed your order we highly recommend you check out the [products](../products) page before you place your order to ensure you know which accessories you might require. -![](/gitbook/assets/getting_started%20%281%29.png) +![](/gitbook/assets/getting_started.png) ## [Step 1: Setting up the hardware](connection/) diff --git a/content/gettingstarted/installation/drivers.md b/content/gettingstarted/installation/drivers.md index 514c220..91c8c6c 100644 --- a/content/gettingstarted/installation/drivers.md +++ b/content/gettingstarted/installation/drivers.md @@ -33,7 +33,7 @@ First navigate open the Windows start menu and search/navigate to \`Device Manag Right click the device and select `Update Driver Software`. -![](/gitbook/assets/win7-2%20%281%29.png) +![](/gitbook/assets/win7-2.png) Select the option to **Browse my computer for driver software**. @@ -41,15 +41,15 @@ Select the option to **Browse my computer for driver software**. Next you will need to navigate to where you downloaded the driver to (e.g. **Downloads** Folder). -![](/gitbook/assets/win7-4%20%281%29.png) +![](/gitbook/assets/win7-4.png) Specify the folder in which the drivers are contained. If you haven't extracted the `.zip` file, please do this before selecting the folder. -![](/gitbook/assets/win7-5%20%281%29.png) +![](/gitbook/assets/win7-5.png) You may receive a warning, suggesting that Windows can't verify the publisher of this driver. Click `Install this driver software anyway` as this link points to our official driver. -![](/gitbook/assets/win7-6%20%281%29.png) +![](/gitbook/assets/win7-6.png) If the installation was successful, you should now see a window specifying that the driver was correctly installed. diff --git a/content/gettingstarted/installation/pymakr.md b/content/gettingstarted/installation/pymakr.md index e9f21a1..a8fc91c 100644 --- a/content/gettingstarted/installation/pymakr.md +++ b/content/gettingstarted/installation/pymakr.md @@ -6,7 +6,7 @@ aliases: - chapter/gettingstarted/installation/pymakr --- -![](/gitbook/assets/pymakr-logo-1%20%281%29.png) +![](/gitbook/assets/pymakr-logo-1.png) ## Pymakr Plugins diff --git a/content/gettingstarted/programming/micropython.md b/content/gettingstarted/programming/micropython.md index e62f670..4abe175 100644 --- a/content/gettingstarted/programming/micropython.md +++ b/content/gettingstarted/programming/micropython.md @@ -8,7 +8,7 @@ aliases: Our boards work with [MicroPython](https://micropython.org/); a Python 3.5 implementation that is optimised to run on micro controllers. This allows for much faster and more simple development process than using C. -![](/gitbook/assets/micropython%20%281%29.jpg) +![](/gitbook/assets/micropython.jpg) ## Booting into MicroPython @@ -16,7 +16,7 @@ When booting, two files are executed automatically: first `boot.py` and then `ma The folder structure in `/flash` looks like the picture below. The files can be managed either using FTP or using the Pymakr Plugin. -![](/gitbook/assets/mp-filestructure%20%281%29.png) +![](/gitbook/assets/mp-filestructure.png) ## Tips & Tricks diff --git a/content/gettingstarted/registration/lora/objenious.md b/content/gettingstarted/registration/lora/objenious.md index 2f66c0a..0bd7b90 100644 --- a/content/gettingstarted/registration/lora/objenious.md +++ b/content/gettingstarted/registration/lora/objenious.md @@ -62,5 +62,5 @@ Follow "Importer des capteurs" under "Statuc do Parc" and select "Provisioning U Once there give your device a name and enter the DevEUI, AppEUI, and AppKey obtained from the steps above: -![](//gitbook/assets/objeniousprovision2%20%281%29.jpg) +![](//gitbook/assets/objeniousprovision2.jpg) diff --git a/content/gettingstarted/registration/lora/ttn.md b/content/gettingstarted/registration/lora/ttn.md index 88f0821..ab6f8d9 100644 --- a/content/gettingstarted/registration/lora/ttn.md +++ b/content/gettingstarted/registration/lora/ttn.md @@ -49,7 +49,7 @@ You can also setup your Pycom module to act as a gateway with The Things Network Inside the TTN Console, there are two options, `Applications` and `Gateways`. Select `Gateways` and then click on `register Gateway`. This will allow for the set up and registration of a new nano-gateway. -![](/gitbook/assets/ttn-2%20%281%29.png) +![](/gitbook/assets/ttn-2.png) On the Register Gateway page, you will need to set the following settings: @@ -80,6 +80,6 @@ Most LoRaWAN network servers expect a Gateway ID in the form of a unique 64-bit Once these settings have been applied, click `Register Gateway`. A Gateway Overview page will appear, with the configuration settings showing. Next click on the `Gateway Settings` and configure the Router address to match that of the gateway (default: `router.eu.thethings.network`). -![](/gitbook/assets/ttn-4%20%281%29.png) +![](/gitbook/assets/ttn-4.png) The `Gateway` should now be configured. diff --git a/content/gettingstarted/registration/sigfox.md b/content/gettingstarted/registration/sigfox.md index 45aa576..b5fcc82 100644 --- a/content/gettingstarted/registration/sigfox.md +++ b/content/gettingstarted/registration/sigfox.md @@ -41,7 +41,7 @@ print(binascii.hexlify(sigfox.pac())) You need to register to the Sigfox Backend. Navigate to [https://backend.sigfox.com/activate](https://backend.sigfox.com/activate) -![](/gitbook/assets/sigfoxactivate%20%281%29.png) +![](/gitbook/assets/sigfoxactivate.png) Find the specific country country where the device will be activated. Enter the device's _Sigfox ID_ and _Sigfox PAC_. @@ -73,10 +73,10 @@ Once you register your device on Sigfox backend, then your Sigfox PAC was used, To get new Sigfox PAC navigate to your device on Sigfox backend. On _device_ click on Sigfox Id of device you want to transfer. -![](/gitbook/assets/sigfoxtableid%20%281%29.png) +![](/gitbook/assets/sigfoxtableid.png) Now you can see your new Sigfox PAC. -![](/gitbook/assets/newsigfoxpac%20%281%29.png) +![](/gitbook/assets/newsigfoxpac.png) Once you know your new Sigfox PAC go to [https://backend.sigfox.com/activate](https://backend.sigfox.com/activate) and register device with different account. diff --git a/content/pymakr/installation/atom.md b/content/pymakr/installation/atom.md index e298b4b..1a2315f 100644 --- a/content/pymakr/installation/atom.md +++ b/content/pymakr/installation/atom.md @@ -42,7 +42,7 @@ After installing the Pymakr Plugin, you need to take a few seconds to configure 3. Now it should show three arrows `>>>`, indicating that you are connected! -![](/gitbook/assets/atom_config_step_7%20%281%29.png) +![](/gitbook/assets/atom_config_step_7.png) These settings can also be applied on a per project basis by clicking `Settings` then `Project Settings`. This will open a JSON file which you can edit to enter your desired settings. diff --git a/content/pymakr/installation/vscode.md b/content/pymakr/installation/vscode.md index 6775327..de5893f 100644 --- a/content/pymakr/installation/vscode.md +++ b/content/pymakr/installation/vscode.md @@ -30,7 +30,7 @@ Please follow these steps to install the [Pymakr VSCode Extension](https://marke 5. That's it! You've installed the Pymakr Extension for VSCode -![](/gitbook/assets/vsc_setup_step_5%20%281%29.png) +![](/gitbook/assets/vsc_setup_step_5.png) ## Connecting via Serial USB @@ -64,7 +64,7 @@ After installing the Pymakr Plugin, you need to take a few seconds to configure 7. Finally close the JSON file, click `All commands`, then `Pymakr > Connect` to connect your device. The Pymakr console should show three arrows `>>>`, indicating that you are connected -![](/gitbook/assets/vsc_config_step_6%20%281%29.png) +![](/gitbook/assets/vsc_config_step_6.png) These settings can also be applied on a per project basis by clicking `All commands` then `Pymakr > Project Settings`. This will open a JSON file which you can edit to enter your desired settings for the currently open project. diff --git a/content/pymakr/toolsfeatures.md b/content/pymakr/toolsfeatures.md index 3a2360b..b08869c 100644 --- a/content/pymakr/toolsfeatures.md +++ b/content/pymakr/toolsfeatures.md @@ -66,7 +66,7 @@ The Pymakr Plugins have a feature to sync and upload code to a device. This can 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%20%281%29.png) +![](/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. diff --git a/content/pytrackpysense/installation/drivers.md b/content/pytrackpysense/installation/drivers.md index 9219108..9987d2f 100644 --- a/content/pytrackpysense/installation/drivers.md +++ b/content/pytrackpysense/installation/drivers.md @@ -24,7 +24,7 @@ First navigate open the Windows start menu and search/navigate to `Device Manage Right click the device and select `Update Driver Software`. -![](/gitbook/assets/win7-2%20%281%29.png) +![](/gitbook/assets/win7-2.png) Select the option to **Browse my computer for driver software**. @@ -32,15 +32,15 @@ Select the option to **Browse my computer for driver software**. Next you will need to navigate to where you downloaded the driver to (e.g. **Downloads** Folder). -![](/gitbook/assets/win7-4%20%281%29.png) +![](/gitbook/assets/win7-4.png) Specify the folder in which the drivers are contained. If you haven't extracted the `.zip` file, please do this before selecting the folder. -![](/gitbook/assets/win7-5%20%281%29.png) +![](/gitbook/assets/win7-5.png) You may receive a warning, suggesting that windows can't verify the publisher of this driver. Click `Install this driver software anyway` as this link points to our official driver. -![](/gitbook/assets/win7-6%20%281%29.png) +![](/gitbook/assets/win7-6.png) If the installation was successful, you should now see a window specifying that the driver was correctly installed. diff --git a/content/tutorials/_index.md b/content/tutorials/_index.md index 16f31c5..824ebc1 100644 --- a/content/tutorials/_index.md +++ b/content/tutorials/_index.md @@ -7,7 +7,7 @@ aliases: disable_breadcrumbs: true --- -![](/gitbook/assets/tutorialsicon%20%281%29.png) +![](/gitbook/assets/tutorialsicon.png) ## Tutorials and Examples diff --git a/content/tutorials/all/rmt.md b/content/tutorials/all/rmt.md index 6fc1cc2..b819590 100644 --- a/content/tutorials/all/rmt.md +++ b/content/tutorials/all/rmt.md @@ -42,7 +42,7 @@ duration = 10000 rmt.pulses_send(duration, data) ``` -![Waveform of example 1](/gitbook/assets/rmt_ex_1%20%281%29.png) +![Waveform of example 1](/gitbook/assets/rmt_ex_1.png) In this example we define the signal by a tuple of durations and what state the signal starts in. @@ -79,7 +79,7 @@ duration = (400,200,100,300,200,400) rmt.pulses_send(duration, data) ``` -![Waveform of example 3](/gitbook/assets/rmt_ex_3%20%281%29.png) +![Waveform of example 3](/gitbook/assets/rmt_ex_3.png) The following example creates an RMT object on channel 4 and configures it for transmission with carrier modulation. diff --git a/content/tutorials/introduction.md b/content/tutorials/introduction.md index 1e0c163..aaaaacc 100644 --- a/content/tutorials/introduction.md +++ b/content/tutorials/introduction.md @@ -6,7 +6,7 @@ aliases: - chapter/tutorials --- -![](/gitbook/assets/tutorialsicon%20%281%29.png) +![](/gitbook/assets/tutorialsicon.png) ## Tutorials and Examples diff --git a/content/tutorials/lora/lorawan-nano-gateway.md b/content/tutorials/lora/lorawan-nano-gateway.md index 07c5d04..f510c7f 100644 --- a/content/tutorials/lora/lorawan-nano-gateway.md +++ b/content/tutorials/lora/lorawan-nano-gateway.md @@ -361,7 +361,7 @@ Once an account has been registered, the nano-gateway can then be registered. To Inside the TTN Console, there are two options, `applications` and `gateways`. Select `gateways` and then click on `register gateway`. This will allow for the set up and registration of a new nano-gateway. -![](/gitbook/assets/ttn-2%20%281%29.png) +![](/gitbook/assets/ttn-2.png) On the Register Gateway page, you will need to set the following settings: @@ -382,7 +382,7 @@ The Gateway EUI should match your Gateway ID from the `config.py` file. We sugge Once these settings have been applied, click `Register Gateway`. A Gateway Overview page will appear, with the configuration settings showing. Next click on the `Gateway Settings` and configure the Router address to match that of the gateway (default: `router.eu.thethings.network`). -![](/gitbook/assets/ttn-4%20%281%29.png) +![](/gitbook/assets/ttn-4.png) The `Gateway` should now be configured. Next, one or more nodes can now be configured to use the nano-gateway and TTN applications may be built. @@ -541,22 +541,22 @@ Once the device has been added, change the `Activation Method` between `OTAA` an Now that the data is arriving on the TTN Backend, TTN can be managed as to where data should be delivered to. To do this, use the `Integrations` tab within the new Application's settings. -![](/gitbook/assets/ttn-7%20%281%29.png) +![](/gitbook/assets/ttn-7.png) Upon clicking `add integration`, a screen with 4 different options will appear. These have various functionality and more information about them can be found on the TTN website/documentation. For this example, use the `HTTP Integration` to forward the LoRaWAN Packets to a remote server/address. -![](/gitbook/assets/ttn-8%20%281%29.png) +![](/gitbook/assets/ttn-8.png) Click `HTTP Integration` to connect up an endpoint that can receive the data. For testing, a website called [RequestBin](https://requestbin.com/), may be used to receive the data that TTN forwards (via POST Request). To set this up, navigate to [RequestBin](https://requestbin.com/) and click the `Create a RequestBin`. -![](/gitbook/assets/ttn-9%20%281%29.png) +![](/gitbook/assets/ttn-9.png) Copy the URL that is generated and past this into the `URL` form under the `Application Settings`. -![](/gitbook/assets/ttn-10%20%281%29.png) +![](/gitbook/assets/ttn-10.png) This is the address that TTN will forward data onto. As soon as a LoPy starts sending messages, TTN will forward these onto `RequestBin` and they will appear at the unique `RequestBin URL`. diff --git a/content/tutorials/pysense.md b/content/tutorials/pysense.md index 27135ca..a71ee97 100644 --- a/content/tutorials/pysense.md +++ b/content/tutorials/pysense.md @@ -24,7 +24,7 @@ while True: time.sleep_ms(100) ``` -![](/gitbook/assets/accelerometer_visualiser%20%281%29.png) +![](/gitbook/assets/accelerometer_visualiser.png) If you want to visualise the data output by this script a Processing sketch is available [here](https://github.com/pycom/pycom-libraries/tree/master/examples/pytrack_pysense_accelerometer) that will show the board orientation in 3D. diff --git a/content/tutorials/sigfox.md b/content/tutorials/sigfox.md index c11b068..02fbf9d 100644 --- a/content/tutorials/sigfox.md +++ b/content/tutorials/sigfox.md @@ -49,7 +49,7 @@ Firstly you will need to log into the [Sigfox Backend](https://backend.sigfox.co You should now see the Information page with an entry `Device Type:` followed by a link. Please follow the link -![screenshot of sigfox ID](/gitbook/assets/seq_dis_2%20%281%29.png) +![screenshot of sigfox ID](/gitbook/assets/seq_dis_2.png) Finally, on this page click on `Disengage sequence number` button in the upper right corner.