Skip to content

Commit 3f3bfde

Browse files
author
Jirka Krepl
authored
Merge pull request #190 from pycom/pybytes-docs-update
Updated sigfox documentation and removed old pybytes docs
2 parents d858182 + f91206c commit 3f3bfde

File tree

55 files changed

+707
-146
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+707
-146
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ static/.DS_Store
1313
static/gitbook/.DS_Store
1414
static/gitbook/assets/.DS_Store
1515
static/gitbook/assets/pybytes/.DS_Store
16+
scripts/githubToken.json

config.toml

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1187,38 +1187,31 @@ theme = "doc-theme"
11871187
weight = 20
11881188

11891189
[[menu.main]]
1190-
name = "Connect to Pybytes: Quick Add"
1190+
name = "Provisioning via USB"
11911191
url = "/pybytes/connect/quick/"
11921192
identifier = "pybytes@connect@quick"
11931193
parent = "pybytes@connect"
11941194
weight = 10
11951195

11961196
[[menu.main]]
1197-
name = "Connect to Pybytes: Flash Pybytes library manually"
1198-
url = "/pybytes/connect/flash/"
1199-
identifier = "pybytes@connect@flash"
1200-
parent = "pybytes@connect"
1201-
weight = 20
1202-
1203-
[[menu.main]]
1204-
name = "Add Sigfox device"
1205-
url = "/pybytes/connect/sigfox/"
1206-
identifier = "pybytes@connect@sigfox"
1207-
parent = "pybytes@connect"
1197+
name = "Sigfox"
1198+
url = "/pybytes/sigfox/"
1199+
identifier = "pybytes@sigfox"
1200+
parent = "pybytes"
12081201
weight = 30
12091202

12101203
[[menu.main]]
12111204
name = "DevKit contract"
1212-
url = "/pybytes/connect/sigfox/devkit/"
1213-
identifier = "pybytes@connect@sigfox@devkit"
1214-
parent = "pybytes@connect@sigfox"
1205+
url = "/pybytes/sigfox/devkit/"
1206+
identifier = "pybytes@sigfox@devkit"
1207+
parent = "pybytes@sigfox"
12151208
weight = 10
12161209

12171210
[[menu.main]]
12181211
name = "Custom contract"
1219-
url = "/pybytes/connect/sigfox/custom/"
1220-
identifier = "pybytes@connect@sigfox@custom"
1221-
parent = "pybytes@connect@sigfox"
1212+
url = "/pybytes/sigfox/custom/"
1213+
identifier = "pybytes@sigfox@custom"
1214+
parent = "pybytes@sigfox"
12221215
weight = 20
12231216

12241217
[[menu.main]]

content/pybytes/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ aliases:
44
- pybytes/introduction
55
---
66

7-
[![pybytes](/gitbook/assets/pybytes/introduction/pybytes_logo.png)](https://pybytes.pycom.io/?utm_source=docs&utm_medium=web&utm_campaign=pybytes-introduction)
7+
![pybytes](/gitbook/assets/pybytes/introduction/pybytes_logo.png)
88

99
## What is Pybytes?
1010

content/pybytes/connect/_index.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,5 @@ Go to the *Devices* page in Pybytes:
2525
1. At the end of the *Add Device* wizard, Pybytes will show that your device profile was successfully created.
2626
![](/gitbook/assets/pybytes/add-device/final-step.png)
2727

28-
## Step 2: Configure your device
29-
30-
There are two options for connecting your device to Pybytes:
31-
32-
1. **Recommended:** [Connect your device quickly with the help of the Firmware Updater](quick)
33-
34-
1. [Connect your device by flashing Pybytes Library](flash) (only if you want to customize Pybytes library code).
28+
## Next step
29+
[Provision your device via USB](quick)

content/pybytes/connect/flash.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

content/pybytes/connect/quick.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Connect the device to Pybytes"
2+
title: "Provisioning via USB"
33
aliases:
44
- pybytes/connect/quick.html
55
- pybytes/connect/quick.md

content/pybytes/connect/sigfox/README.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

content/pybytes/integrations/README.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

content/pybytes/connect/sigfox/_index.md renamed to content/pybytes/sigfox/_index.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,26 @@ Once you have you account setup and are logged in Sigfox backend, you need to cr
1313

1414
Click on GROUP → <your\_company\_name> → API ACCESS → New
1515

16-
![](/gitbook/assets/apiaccess%20%281%29.png)
16+
![](/gitbook/assets/pybytes/sigfox/apiaccess.png)
1717

1818
In the form chose arbitrary _name_, select `LIMITED_ADMIN` and Profile and click on Ok.
1919

20-
![](/gitbook/assets/apiaccessscope.png)
20+
![](/gitbook/assets/pybytes/sigfox/apiaccessscope.png)
2121

2222
Copy _Login_ and _Password_ to the clipboard.
2323

24-
![](/gitbook/assets/apiaccesskeys.png)
24+
![](/gitbook/assets/pybytes/sigfox/apiaccesskeys.png)
2525

2626
In Pybytes go to Settings → Sigfox API or [follow this link](https://pybytes.pycom.io/settings/sigfox-credentials) then paste in the form.
2727

28-
![](/gitbook/assets/pybytessigfoxcredentials.png)
28+
![](/gitbook/assets/pybytes/sigfox/pybytessigfoxcredentials.png)
2929

3030
## Sigfox contract types
3131

3232
### Sigfox DevKit contracts
3333

3434
Read more how to use Sigfox with [devKit contract](devkit).
3535

36-
{{% refname "devkit.md" %}}
37-
3836
### Sigfox custom contracts
3937

4038
Read more how to use Sigfox with [Custom contract](devkit).
41-
42-
{{% refname "custom.md" %}}

content/pybytes/connect/sigfox/custom.md renamed to content/pybytes/sigfox/custom.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Go to: Settings (in sidebar) → Sigfox API → Settings
2020

2121
and select Sigfox device type which is associated with Sigfox custom contract.
2222

23-
![](/gitbook/assets/selectdevicetypecustomcontract.png)
23+
![](/gitbook/assets/pybytes/sigfox/selectdevicetypecustomcontract.png)
2424

2525
### Add your Sigfox device to Pybytes
2626

@@ -30,12 +30,12 @@ and select Sigfox device type which is associated with Sigfox custom contract.
3030
2. Paste your device token to firmware updater
3131

3232
{{% hint style="info" %}}
33-
Detailed steps which are same for all devices are [**described here**](../../quick).
33+
Detailed steps which are same for all devices are [**described here**](/pybytes/connect/quick).
3434
{{% /hint %}}
3535

3636
After your device was flashed with Pybytes firmware in automatically start adding itself to Sigfox backend.
3737

38-
![](/gitbook/assets/sigfoxcustomcontractstatus%20%281%29.png)
38+
<img src="/gitbook/assets/pybytes/sigfox/sigfoxcustomcontractstatus.png" alt="sigfox settings in Pybytes" width="45%">
3939

4040
## Troubleshooting
4141

0 commit comments

Comments
 (0)