* added assets

* feat: pylife documentation getting started, alerts, groups

* fix: moving to separate folders

* feat: add pylife to menu config

* feat: add static pictures

* fix: add static pictures, update device text

* added assets

* feat: pylife documentation getting started, alerts, groups

* fix: moving to separate folders

* feat: add pylife to menu config

* feat: add static pictures

* fix: add static pictures, update device text

* Update config.toml

* Create _index.md

Add template for firmware update instructions

* Update PyLife instructions and adding devices instructions

* Add warning and update menu to include firmware update

* Update the getting started and devices section

* Add firmware update instructions

* Add firmware update images

* Add messaging

* Move images to correct location

* fix: resolve suggestions

* Update PyLife documentation to clarify Devices, add more data, and improve the firmware update instructions

* Reduce size of age warning image so it isn't the whole screen on a computer

* Add the PC update section

* Fix a merge typo

* Resize images to be smaller on big monitors

Co-authored-by: njilrem <antoinekucher@gmail.com>
Co-authored-by: njilrem <anton.kucher@chisw.com>
Co-authored-by: Pete Allen <pete@pycom.io>
Co-authored-by: PetePycom <105786769+PetePycom@users.noreply.github.com>
This commit is contained in:
Christian Ehlers
2022-06-23 14:27:50 +02:00
committed by GitHub
parent cdc5b031da
commit 70512100f0
14 changed files with 183 additions and 36 deletions

View File

@@ -6,9 +6,9 @@ title: "Pylife"
## What is Pylife?
The Pylife App is our digital dashboard, where you will find all of your PyGo devices and their owners. It has messaging, mapping and visualisation features, all in a bid to connect a community of people.
The Pylife App is our digital dashboard, where you will find all of your PyGos and their owners. It has messaging, mapping and visualisation features, all in a bid to connect a community of people.
We have spent years in the technology field developing multi-network solutions. This means that the Pylife app will work with five different types of network. That means that youre not paying for a device that only works in certain cases.
We have spent years in the technology field developing multi-network solutions. This means that the Pylife app will work with five different types of network. That means that you're not paying for a device that only works in certain cases.
* Create groups, invite your people add devices;
* Create alerts from templates for your devices, configure them;

View File

@@ -3,29 +3,47 @@ title: "Alerts"
aliases:
---
Alerts can be used in multiple ways for manipulation of PyGo devices.
Alerts can be used in multiple ways on your PyGo devices.
![Alerts templates](/gitbook/assets/pylife/alerts/alert_templates.png)
There are currently 3 templates, more will be added later. The current ones are:
You can use one of our 3 pre-configured templates for distance, battery monitoring and stumbling.
#### Distance Template
To create an Alert you need to:
* Notifies if PyGo is far or closer than N meters to the chosen location
1. Tap`Alerts`on the bottom of the screen menu
2. Tap`Templates`on the top of the screen header
3. Choose the template you need
4. Change the name, set up required conditions, set up notification method
5. Tap`Save as new Alert`
#### <b>The Distance Template</b>
* Notifies if PyGo is far or closer than N meters to the chosen location
* Tracking of location of your beloved
* Tracking of pets outdoors
* Interaction between team members during sport activities
* Interaction between team members during sport activities
#### Battery Template
#### <b>The Battery Template</b>
* Notifies if PyGo's battery level is less than N %
* Helps to prevent the outcharging of your PyGo or Pysence
* This template helps you manage your battery life.
* It Notifies you if your PyGos battery level is less than a chosen battery life %
* This helps to prevent the PyGo running out of charge
#### Stumbling Template
* Notifies if PyGo has fallen down and stays more than N min
* Is crucial for the seniors, because it can help to uncover the life-threatening issue
* Your pet has lost the PyGo tracker
#### <b>The Stumbling Template</b>
This template helps you receive alerts if the PyGo is carried and the accelerometer is activated for instance by someone who falls. It can also be used for other use cases.
* It notifies you if PyGo has fallen down and stays more than a defined set of minutes
* This could be important for the vulnerable person
* This could also notify you that your pet has lost the PyGo device
![Create alert](/gitbook/assets/pylife/alerts/create_alert.png)
### Create alerts

View File

@@ -1,19 +1,85 @@
---
title: "Devices"
title: "Introduction to PyGos"
aliases:
- pylife/devices.html
- pylife/devices.md
- chapter/pylife/devices
---
After installing the app, you will be asked to connect your device. Remember to turn on the bluetooth on your device.
## PyGo Overview
This can also be done anytime in the Devices menu section.
![PyGo Top View](/gitbook/assets/pylife/devices/thumbnail_PyGoTopView.png)
![PyGo Top View](/gitbook/assets/pylife/devices/thumbnail_PyGoBottomView.png)
* Dimensions: 41 x 24 x 12.5mm
* Weight: 24g
* [PyGo Datasheet](/gitbook/assets/pylife/devices/Pycom_001_Specsheets_PYGO_v1.pdf)
The optional USB cradle allows you to charge the PyGo over USB as well as to connect to the serial port for development purposes.
![PyGo Top View](/gitbook/assets/pylife/devices/thumbnail_PyGoChargeCradle.png)
## Connecting PyGos
After installing the Mobile App, you will be asked to connect your PyGos.
This can also be done anytime in the 'Devices' tab of PyLife.
1) Put a PyGo on to a Qi-compatible wireless charger or into a USB cradle to start charging and wake it up. Make sure it is within a few meters of your phone.
2) Once the PyGo screen shows it is charging, in Pylife tap `Start Scanning`. Pylife will use your phone's Bluetooth to look for PyGos.
3) The device will have a unique ID (e.g. PyGo 12345) which cannot be changed, but you can optionally give it a name to easily identify it.
4) Click 'Add PyGo', and your PyGo is now paired. Please now proceed imediately to update its firmware.
5)
![Device Scanning](/gitbook/assets/pylife/devices/device_scanning.png)
![Device Scanning](/gitbook/assets/pylife/devices/device_active_scan.png)
At this point you can put a PyGo on to a Qi-compatible wireless charger or into a USB cradle to start charging and wake it up.
Your added PyGos are displayed under the Devices menu section.
You can add more than one PyGo to your App. If you do this, make sure to give each PyGo an obvious name and we recommend you go through the complete setup process for one of them before starting with the next.
![Devices List](/gitbook/assets/pylife/devices/devices_list.png)
## Frequently Asked Questions
* How do I turn my PyGo on?
* Your PyGo is an always on device. You can wake it up by charging it, or by double tapping the screen.
* How do I charge my PyGo?
* You can charge your PyGo either by placing it on a Qi-compatible wireless charger, or by putting it in a USB cradle. When it is charging a charging animation will appear on the screen. Charging from 0% takes approximately 3-4 hours on USB, or 6-8 hours on a wireless charger.
* How will I know when the PyGo is fully charged?
* When your PyGo is fully charged it will show this on the display, and also in the 'Devices' section of the PyLife app.
* How long will the battery last for?
* A PyGo has three power profiles: Performance, Standard, and Eco. Battery life is still being characterised, and depends heavily on network and physical conditions.
* In performance mode the PyGo is most responsive and will wake up every 60 seconds unless it is woken with a double tap. In this mode the battery life is approximately 6 hours.
* In Standard mode the PyGo will sleep for 5 minutes between updates unless it is woken up with a double tap. The battery life is approximately 12 hours.
* In Eco mode the PyGo will sleep for 15 minutes between updates unless it is woken up with a double tap. The battery life is approximately 18 hours.
* How do I turn my PyGo Off?
* You do not need to turn the PyGo off. If you want to prolong battery life simply turn it to Eco mode in the app.
* What chargers are compatible with PyGos?
* All Qi compatible wireless chargers are compatible.
* My PyGo gets hot while charging?
* It is normal for devices that are using wireless charging to release heat. Due to the small size of the PyGo it can feel quite hot to touch as it radiates the heat. This is normal, and the temperature is monitored internally to keep it at safe levels. However as with all electronics you should not leave it unattended while charging.
* Shall I leave my PyGo Charging over night or when I am not present?
* No. As with all electronics, you should always remain prudent and charge the PyGo only when you are present and conscious.
* Is the recessed button on the bottom of the PyGo a reset button?
* No. The hole on the bottom with a recessed red subtance is part of the environmental sealing, so should not be pressed as this may effect the IP rating of the device.
## PyGo Settings
To open the PyGo settings, go to the 'Devices' tab and tap on the PyGo in the list.
Here you can do:
* Connect alerts to the device
* Check and configure mesh details
* Check and configure device details
* Forget the PyGo
* Upload device icon
![Device Settings](/gitbook/assets/pylife/devices/device_settings_with_alert.png)
Once the screen shows it is charging, click the 'Start scanning' button, and the app should find your PyGo.
The device will have a unique ID (e.g. PyGo 12345) which cannot be changed, but you can optionally give it a name to easily identify it.
@@ -29,3 +95,4 @@ Please note: if you have more than one PyGo, we recommend you go through the com
To open the device settings tap on the device in the list. You can add alerts, check mesh and device details here.
![Device Settings](/gitbook/assets/pylife/devices/device_settings_with_alert.png)

View File

@@ -10,7 +10,7 @@ After installing the app, please do a firmware update immediately by following t
## Firmware update
In PyLife, go to the devices tab and select your PyGo:
In PyLife, go to the 'Devices' tab and select your PyGo:
![Devices tab iOS](/gitbook/assets/pylife/fwupdate/devices_menu_iOS.png)
@@ -31,8 +31,36 @@ Once it has reconnected, you are ready to go.
## Troubleshooting
If the firmware update fails, you can reconnect to the PyGo and try again. It will prompt you to resume the update, and should subsequently update successfully.
A video demonstrating this is available
If the firmware update fails, you can reconnect to the PyGo and try again. It will prompt you to resume the update, and should subsequently update successfully. This should fix the majority of firmware update issues.
[A video demonstrating this is available here](/gitbook/assets/pylife/fwupdate/PyGoFirmwareUpdate.mp4)
### PyGo not responding
If your PyGo stops responding in PyLife, and doesn't display a charging symbol when placed on a suitable charger, it may have entered an error state. We have discovered a bug in the firmware the PyGos are shipped with where in unusual circumstances involving the GPS the PyGo can enter this state where it does not respond to external input.
The immediate firmware update resolves this issue, but if you do encounter please do the following:
1) Leave the PyGo off the charger until the battery is discharged (this may take a day or so, but will be much quicker if the battery is not fully charged)
2) Wake up the PyGo using a charger, either on a Qi compatible charger or by placing it in a charging cradle
3) Restart the update process. PyLife should prompt you to resume the update, and fix the issue.
## Manual firmware update from computer
For most people, firmware update through the app is the best option. However it is possible to update through a computer if you have the USB cradle or can connect to the PyGo's serial port through a computer.
If you want to do this, do the following:
1) Download the relevant firmware for your PyGo. Click on the relevant link below, and download the firmware in the URL field
* [PyGo1 firmware](https://software.pycom.io/manifest.json?sysname=pygo1&fwtype=pylife&current_ver=1.20.4)
* [PyGo2 firmware](https://software.pycom.io/manifest.json?sysname=pygo2&fwtype=pylife&current_ver=1.20.4)
2) Connect to your PyGo's serial terminal, and run `update()`
3) On your computer, connect to the PyGo's access point:
* SSID: PyCom_AP_Firmware_Update
* Password: pycom
4) Open up a command prompt or terminal, navigate to the directory your downloaded firmware is in, and run the following, replacing YOUR_FIRMWARE_HERE with firmware you have downloaded:
```
curl -v --request GET http://192.168.4.1/status -H "FW-Header-1: ota-init"
curl -v --request GET http://192.168.4.1/status -H "FW-Header-1: ota-update"
curl --request POST --data-binary @YOUR_FIRMWARE_HERE.bin http://192.168.4.1/update
curl -v --request GET http://192.168.4.1/status -H "FW-Header-1: ota-finish"
curl -v --request GET http://192.168.4.1/status -H "FW-Header-1: ota-verify"
curl -v --request GET http://192.168.4.1/status -H "FW-Header-1: ota-reboot"
```
5) Check that all commands have run succesfully without error. Your PyGo is now upgraded.
We have discovered a bug in the firmware the PyGo's are shipped with where in unusual circumstances involving the GPS the PyGo can enter a locked state where it does not respond to external input.
The immediate firmware update resolves this issue, but if you do encounter it leave the PyGo off the charger until the battery is discharged and when you restart do a firmware update.

View File

@@ -5,33 +5,67 @@ aliases: pylife/gettingstarted.md
aliases: chapter/pylife/gettingstarted
---
To get started with your PyGo's you will need to install PyLife, create an account, and then update the PyGo firmware to the latest version.
Pylife is a mobile App that lets you set up, configure and manage your PyGos.
The Pylife app is available on the [Apple App Store](https://apps.apple.com/nl/app/pylife/id1615965596?l=en ) and on [Google Play](https://play.google.com/store/apps/details?id=io.pycom.pylife).
For app to work properly you will need to allow it to update the necessary permissions.
### WARNING
![age warning label](/gitbook/assets/pylife/gettingstarted/age_warning_label.png)
The PyGo is not a toy!
To avoid danger of suffocation, please keep out of reach of babies, children, and pets. These must be supervised when a PyGo is attached to them.
### GETTING STARTED WITH PYLIFE
Before you Use the PyGo
* Charge your PyGo on a wireless charger until the screen shows a full charge
To charge you can use:
* PyGo Qi Charger
* PyGo Charge Cradle
* Your own Qi compatible wireless charger
First use:
1. Download the Pylife App from the iOS or the Android App Store
Android Shop:
* https://play.google.com/store/apps/details?id=io.pycom.pylife
Apple iOS:
* https://apps.apple.com/nl/app/pylife/id1615965596?l=en
2. Open the Pylife App and create an Account via your phone
For app to work properly, please allow the Pylife App to access your location and allow any other necessary permissions, as prompted on your phone.
![Permissions Android Screenshot](/gitbook/assets/pylife/gettingstarted/permissions_android.jpg)
![Permissions iOS Screenshot](/gitbook/assets/pylife/gettingstarted/permissions_ios.png)
### Create a Pylife account
### Create a Pylife Account
To get going you will need to create a Pylife account. This is separate from other Pycom accounts.
* Tap `Sign Up Here` on the bottom of the screen
* Enter your name, surname, email, strong password and agree to the terms of service and privacy policy
* Tap `Create Account`
* To finish creating your account, you need to confirm your email
1. Tap `Sign Up Here` on the bottom of the screen
2. Enter your name, surname, email, strong password and agree to the terms of service and privacy policy
3. Tap `Create Account`
4. To finish creating your account, you need to confirm your email
5. Please note- PyLife requires a separate account to other Pycom services
To confirm your email, click or tap the link in the email you got when you created your account.
`Note: Confirming your email or mobile number helps us know that we're sending your account info to the right place.`
Your Pylife Account is now live.
![Sign up form Android](/gitbook/assets/pylife/signup/signup_android.jpg)
Once this is complete, you can login using these details.
### Login to your Pylife Account
### Log in
Once you are logged in you should see the main screen, and are ready to add your Pygo devices
Once you are logged in you should see the main screen, and are ready to add your PyGos.
![Create account form Android Screenshot](/gitbook/assets/pylife/gettingstarted/main_screen_android.jpg)
@@ -39,7 +73,6 @@ Once you are logged in you should see the main screen, and are ready to add your
### Reset Password
Should you need to reset your account password, tap `Forgot Password?` and enter the email your account is linked to.
Your next steps would be:
* You should recieve email with link to reset a password and click on it
* Enter your new password and confirm it by entering it again
@@ -51,3 +84,4 @@ Your next steps would be:
To logout tap on the icon on the top right of the screen
Your account info opens and you can confirm the logout by tapping `Logout`

Binary file not shown.

After

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 227 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 168 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 503 KiB

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 767 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 358 KiB

After

Width:  |  Height:  |  Size: 18 KiB