GitBook: [master] 105 pages and 326 assets modified

This commit is contained in:
Daniel Spindelbauer
2018-08-20 18:25:04 +00:00
committed by gitbook-bot
parent 7f83446ce9
commit 764a0073d6
414 changed files with 499 additions and 29723 deletions

View File

@@ -8,29 +8,29 @@ In Pybytes, go to `Devices` Page:
1. Click on `Add Device`.
![](../../.gitbook/assets/1%20%281%29.jpg)
![](../../.gitbook/assets/1-1.jpg)
2. Select your device \(e.g., WiPy, LoPy, SiPy, etc.\);
1. Select your device \(e.g., WiPy, LoPy, SiPy, etc.\);
![](../../.gitbook/assets/2%20%281%29.jpg)
![](../../.gitbook/assets/2-1.jpg)
3. Select your shield \(e.g., PySense, PyTrack, PyScan or other\);
1. Select your shield \(e.g., PySense, PyTrack, PyScan or other\);
![](../../.gitbook/assets/3.jpg)
![](../../.gitbook/assets/3%20%281%29.jpg)
4. Select your network option;
1. Select your network option;
![](../../.gitbook/assets/4.jpg)
![](../../.gitbook/assets/4%20%281%29.jpg)
5. Enter a unique name and the network credentials \(SSID and password\) for your device;
1. Enter a unique name and the network credentials \(SSID and password\) for your device;
![](../../.gitbook/assets/5%20%281%29.jpg)
![](../../.gitbook/assets/5-1.jpg)
## Step 2: Connect your device to Pybytes
At the end of the "Add Device" wizard, Pybytes will give you two options for you to connect your device to Pybytes:
![](../../.gitbook/assets/7%20%281%29.png)
![](../../.gitbook/assets/7-1.png)
Select how you would like to connect your device to Pybytes:
@@ -38,7 +38,7 @@ Select how you would like to connect your device to Pybytes:
{% page-ref page="quick.md" %}
2. [Connect your device by flashing Pybytes Library](flash.md)
1. [Connect your device by flashing Pybytes Library](flash.md)
{% page-ref page="flash.md" %}

View File

@@ -12,19 +12,19 @@ From firmware 1.16.x onwards all Pycom devices come with Pybytes library build-i
At the last step of the "Add Device" process:
![](../../.gitbook/assets/pybyteslib-box%20%281%29.gif)
![](../../.gitbook/assets/pybyteslib-box-1.gif)
1. Click on download "Pybytes library"
![](../../.gitbook/assets/pybytes-library-wizard.png)
![](../../.gitbook/assets/pybytes-library-wizard%20%281%29.png)
You can also download _Pybytes library_ at the device's settings page:
1. Navigate to your device in Pybytes;
1. Navigate to your device in Pybytes;
2. On your device's page click on settings tab;
3. Click on the button _Download_ at Pybytes library;
![](../../.gitbook/assets/pybytes-library-download.gif)
![](../../.gitbook/assets/pybytes-library-download%20%281%29.gif)
### Step 2. Flash your device with Pymakr

View File

@@ -12,13 +12,13 @@ In case you want to extend Pybytes library you can flash Pybytes library manuall
At the last step of the "Add Device" process:
![](../../.gitbook/assets/7%20%281%29.png)
![](../../.gitbook/assets/7-1.png)
1. Download the [firmware updater](https://pycom.io/downloads/) for your operating system;
![](../../.gitbook/assets/8%20%281%29.png)
![](../../.gitbook/assets/8-1.png)
2. Copy the device token.
1. Copy the device token.
### Step 2: Firmware updater
@@ -26,25 +26,24 @@ Install the Firmware updater on your computer.
1. Start the `Firmware updater`;
![](../../.gitbook/assets/1%20%281%29.png)
![](../../.gitbook/assets/1-1.png)
![](../../.gitbook/assets/2.png)
![](../../.gitbook/assets/2%20%281%29.png)
2. Select your device serial port \(Make sure your device is connected to your computer\);
3. Mark the options "Erase flash file system" and "Force update Pybytes registration";
1. Select your device serial port \(Make sure your device is connected to your computer\);
2. Mark the options "Erase flash file system" and "Force update Pybytes registration";
![](../../.gitbook/assets/3.png)
4. Paste your device token from Pybytes;
1. Paste your device token from Pybytes;
![](../../.gitbook/assets/5%20%281%29.gif)
![](../../.gitbook/assets/5-1.gif)
5. The firmware updater will update the device's firmware.
1. The firmware updater will update the device's firmware.
![](../../.gitbook/assets/6.png)
![](../../.gitbook/assets/6%20%281%29.png)
![](../../.gitbook/assets/7.png)
![](../../.gitbook/assets/7%20%282%29.png)
## Next step: Set up your device's dashboard!

View File

@@ -10,7 +10,7 @@ Once you have you account setup and are logged in Sigfox backend, you need to cr
Click on GROUP → <your\_company\_name> → API ACCESS → New
![](../../../.gitbook/assets/apiaccess.png)
![](../../../.gitbook/assets/apiaccess%20%281%29.png)
In the form chose arbitrary _name_, select Profiles `DEVICE MANAGER [R]` and `DEVICE MANAGER [W]`. Then click on Ok.
@@ -38,5 +38,3 @@ Read more how to use Sigfox with [Custom contract](devkit.md).
{% page-ref page="custom.md" %}

View File

@@ -29,7 +29,7 @@ Detailed steps which are same for all devices are [**described here**](../quick.
After your device was flashed with Pybytes firmware in automatically start adding itself to Sigfox backend.
![](../../../.gitbook/assets/sigfoxcustomcontractstatus.png)
![](../../../.gitbook/assets/sigfoxcustomcontractstatus%20%281%29.png)
## Troubleshooting

View File

@@ -6,7 +6,7 @@ But every device you want to add to Pybytes you need register on Sigfox backend.
After you add your Sigfox credentials to Pybytes you can see DevKit contract type is selected as default \(on page Settings → Sigfox API\).
![](../../../.gitbook/assets/pybytesdevkit.png)
![](../../../.gitbook/assets/pybytesdevkit%20%281%29.png)
## Add your device to Pybytes

View File

@@ -15,5 +15,3 @@ Now it's time to explore Pybytes. You can start by connecting your Pycom board t
{% page-ref page="add-device/" %}

View File

@@ -1,6 +1,6 @@
# Introduction
![](../.gitbook/assets/pybyteslogo.png)
![](../.gitbook/assets/pybyteslogo%20%281%29.png)
## What is Pybytes?

View File

@@ -42,12 +42,12 @@ _thread.start_new_thread(send_env_data, ())
1. Upload the code into your device. Now your device is sending data to Pybytes.
{% hint style="info" %}
In this code, we're calling the function `pybytes.send_virtual_pin_value(persistent, pin, value))` to communicate with Pybytes. This function is part of the Pybytes library, and it has three arguments: `persistent`, `pin` and `value`.
* `persistent` denotes information that is infrequently accessed and not likely to be modified;
* `pin` represents which virtual pin is receiving data;
* `value` is the value being attributed to that particular pin.
{% endhint %}
## Step 2: Add a signal from your device
@@ -55,23 +55,23 @@ Go to Pybytes.
1. On `Devices` page select a device;
![](../.gitbook/assets/01.gif)
![](../.gitbook/assets/01%20%281%29.gif)
2. On your device's page click on `Data` tab.
1. On your device's page click on `Data` tab.
![](../.gitbook/assets/02%20%281%29.png)
![](../.gitbook/assets/02-1.png)
3. Click on the `Define New Signal` button.
1. Click on the `Define New Signal` button.
![](../.gitbook/assets/03%20%281%29.png)
![](../.gitbook/assets/03-1.png)
4. Define the new signal by entering a number, a name, a data type and a unit. Finally, click on the button `Define`.
1. Define the new signal by entering a number, a name, a data type and a unit. Finally, click on the button `Define`.
![](../.gitbook/assets/04%20%281%29.gif)
![](../.gitbook/assets/04-1.gif)
5. Your signal was added!
1. Your signal was added!
![](../.gitbook/assets/05.png)
![](../.gitbook/assets/05%20%281%29.png)
{% hint style="info" %}
The name and unit are labels used to identify your signal inside Pybytes \(In this example we defined `Sinwave` as the name of the signal and `Rad` as the unit\).
@@ -87,27 +87,27 @@ The datatype also has to match the variable used as argument on `pybytes.send_vi
![](../.gitbook/assets/01.png)
2. Click on the button `Create a new display`.
1. Click on the button `Create a new display`.
![](../.gitbook/assets/02-1.png)
![](../.gitbook/assets/02-1%20%281%29.png)
3. Select the type of visualisation \(e.g. Bar chart or Line chart\).
1. Select the type of visualisation \(e.g. Bar chart or Line chart\).
![](../.gitbook/assets/03.gif)
4. You can adjust the parameters of your widget at `Settings`. After, click on the button `Create`.
1. You can adjust the parameters of your widget at `Settings`. After, click on the button `Create`.
![](../.gitbook/assets/04%20%281%29.png)
![](../.gitbook/assets/04-1.png)
5. Your widget was created. Now, add your widget to your device's dashboard. Click on the button `Edit` on your widget.
1. Your widget was created. Now, add your widget to your device's dashboard. Click on the button `Edit` on your widget.
![](../.gitbook/assets/05-1.png)
6. Mark the checkbox `Display on Dashboard` at `Settings`. Finally, click on the button `Save`.
1. Mark the checkbox `Display on Dashboard` at `Settings`. Finally, click on the button `Save`.
![](../.gitbook/assets/06.gif)
7. Click on the tab `Dashboard`. Your widget was successfully added there!
1. Click on the tab `Dashboard`. Your widget was successfully added there!
![](../.gitbook/assets/07.png)
@@ -115,13 +115,13 @@ The datatype also has to match the variable used as argument on `pybytes.send_vi
1. Click on the button `Organise`. Now the dashboard's grid will enter the edit mode and allow you to resize and reposition its widgets.
![](../.gitbook/assets/edit-mode.gif)
![](../.gitbook/assets/edit-mode%20%281%29.gif)
2. Resize a widget by clicking on the triangle icon at the bottom right corner of the widget and drag the cursor over the grid. After, click on the button `Save` to save this action.
1. Resize a widget by clicking on the triangle icon at the bottom right corner of the widget and drag the cursor over the grid. After, click on the button `Save` to save this action.
![](../.gitbook/assets/02%20%281%29.gif)
![](../.gitbook/assets/02-1.gif)
3. Change the widget's position by drag-and-dropping it over the grid. After, click on the button `Save` to save this action.
1. Change the widget's position by drag-and-dropping it over the grid. After, click on the button `Save` to save this action.
![](../.gitbook/assets/03-1.gif)