Pylife documentation (#491)

* 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

Co-authored-by: Christian Ehlers <cehlers@pycom.io>
Co-authored-by: Pete Allen <pete@pycom.io>

config.toml

@@ -500,8 +500,8 @@ theme = "doc-theme"
     identifier = "tutorials@advanced"
     parent = "tutorials"
     weight = 70
-    
-    
+
+
 [[menu.main]]
     name= "File decompression"
     url= "/tutorials/advanced/uzlib/"
@@ -1244,7 +1244,7 @@ theme = "doc-theme"
     identifier = "datasheets@notes"
     parent = "datasheets"
     weight = 50
-    
+
 [[menu.main]]
     name= "Helium Hotspot Miner"
     url = "/datasheets/helium_hotspot"
@@ -1563,6 +1563,55 @@ theme = "doc-theme"
     parent = "pymesh"
     weight = 90
 
+# *** Pylife
+[[menu.main]]
+    name = "Pylife"
+    url = "/pylife/"
+    identifier = "pylife"
+    weight = 95
+
+[[menu.main]]
+    name = "Getting Started"
+    url = "/pylife/gettingstarted/"
+    identifier = "pylife@gettingstarted"
+    parent = "pylife"
+    weight = 10
+
+[[menu.main]]
+    name = "Alerts"
+    url = "/pylife/alerts/"
+    identifier = "pylife@alerts"
+    parent = "pylife"
+    weight = 50
+
+[[menu.main]]
+    name = "Devices"
+    url = "/pylife/devices/"
+    identifier = "pylife@devices"
+    parent = "pylife"
+    weight = 20
+
+[[menu.main]]
+    name = "Firmware Update"
+    url = "/pylife/fwupdate/"
+    identifier = "pylife@fwupdate"
+    parent = "pylife"
+    weight = 30
+
+[[menu.main]]
+    name = "Groups"
+    url = "/pylife/groups/"
+    identifier = "pylife@groups"
+    parent = "pylife"
+    weight = 40
+
+[[menu.main]]
+    name = "Messaging"
+    url = "/pylife/messaging/"
+    identifier = "pylife@messaging"
+    parent = "pylife"
+    weight = 50
+
 # *** Cellular Services
 [[menu.main]]
     name = "Cellular Services"

content/pylife/_index.md

@@ -0,0 +1,31 @@
+---
+title: "Pylife"
+---
+
+![pylife](/gitbook/assets/pylife/pylife_logo@3x.png)
+
+## 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.
+
+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;
+* Monitor activity of your devices, receive real-time updates;
+* Share your activity with your people through groups;
+
+## WARNING 
+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. 
+
+
+**IMPORTANT:** Please make sure you first open the PyGo case inside a building (out of sight of Satellites) and proceed to updating the firmware via the Pylife App as described below. 
+
+## Let's get started!
+
+* [Getting started with Pylife](/pylife/gettingstarted/)
+* [Add and configure your devices in Pylife](/pylife/devices/)
+* [Update the firmware](/pylife/fwupdate/)
+* [Use groups in Pylife](/pylife/groups/)
+* [Use alerts in Pylife](/pylife/alerts/)

content/pylife/alerts/_index.md

@@ -0,0 +1,55 @@
+---
+title: "Alerts"
+aliases:
+---
+
+Alerts can be used in multiple ways for manipulation of 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:
+
+#### Distance Template
+
+* 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
+
+#### Battery Template
+
+* Notifies if PyGo's battery level is less than N %
+* Helps to prevent the outcharging of your PyGo or Pysence
+
+#### 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
+
+### Create alerts
+
+To create alert you need to:
+
+* Tap `Alerts` on the bottom of the screen menu
+* Tap `Templates` on the top of the screen header
+* Choose the template you need
+* Change the name, set up required conditions, set up notification method
+* Tap `Save as new Alert`
+
+![Create alert](/gitbook/assets/pylife/alerts/create_alert.png)
+
+### Edit alerts
+
+To edit alert you need to:
+
+* Tap `Alerts` on the botton of the screen menu
+* Tap on the alert you'd like to edit
+* Edit all needed parameters
+
+### Activate alerts
+
+To activate alert you need to:
+
+* Go to the settings screen of your device
+* Choose alerts you'd like to activate

content/pylife/devices/_index.md

@@ -0,0 +1,31 @@
+---
+title: "Devices"
+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.
+
+This can also be done anytime in the Devices menu section.
+
+![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.
+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.
+
+Your added devices are displayed under the Devices menu section.
+Click 'Add PyGo', and your device is now paired. Please now proceed imediately to update its firmware.
+
+Please note: if you have more than one PyGo, 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)
+
+### Device Settings
+
+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)

content/pylife/fwupdate/_index.md

@@ -0,0 +1,38 @@
+---
+title: "Firmware Update"
+aliases:
+    - pylife/fwupdate.html
+    - pylife/fwupdate.md
+    - chapter/pylife/fwupdate
+---
+
+After installing the app, please do a firmware update immediately by following the instructions below.
+
+
+## Firmware update
+In PyLife, go to the devices tab and select your PyGo:
+
+![Devices tab iOS](/gitbook/assets/pylife/fwupdate/devices_menu_iOS.png)
+
+Scroll down to the bottom and select 'UPDATE FIRMWARE'
+
+![Devices tab iOS](/gitbook/assets/pylife/fwupdate/device_details_iOS.png)
+
+If an update is available, click install
+
+![Devices tab iOS](/gitbook/assets/pylife/fwupdate/update_available_iOS.png)
+
+You will be prompted to join a new WiFi access point. Please click join. You will temporarily be disconnected from the internet, so if you have any active connections they will be terminated.
+
+![Devices tab iOS](/gitbook/assets/pylife/fwupdate/update_join_wifi_iOS.png)
+
+After a few moments the firmware update should complete, and your PyGo will automatically reboot.
+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
+
+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.

content/pylife/gettingstarted/_index.md

@@ -0,0 +1,53 @@
+---
+title: "Getting Started with Pylife"
+aliases: pylife/gettingstarted.html
+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.
+
+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.
+
+![Permissions Android Screenshot](/gitbook/assets/pylife/gettingstarted/permissions_android.jpg)
+![Permissions iOS Screenshot](/gitbook/assets/pylife/gettingstarted/permissions_ios.png)
+
+### 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
+
+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.`
+
+![Sign up form Android](/gitbook/assets/pylife/signup/signup_android.jpg)
+
+Once this is complete, you can login using these details.
+
+### Log in
+Once you are logged in you should see the main screen, and are ready to add your Pygo devices
+
+![Create account form Android Screenshot](/gitbook/assets/pylife/gettingstarted/main_screen_android.jpg)
+
+
+### 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
+* Tap `Save` and you should see the status page for your password reset
+* Tap `Go to Login Form` and login into your account
+
+### Logout
+
+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`

content/pylife/groups/_index.md

@@ -0,0 +1,60 @@
+---
+title: "Groups"
+aliases:
+---
+
+## Pylife Groups Functionalities
+
+Groups are used for communication with your people and PyGo devices.
+
+You can create and invite members and add devices to your groups.
+
+### Group Creation
+
+To create a group the steps are:
+
+* Tap `Groups` on the bottom of the screen
+* Tap `Create Group` and you will be navigated to the group creation form
+* Provide a unique name for your group and tap `Add Group`
+
+![Create group](/gitbook/assets/pylife/groups/add_group_android.jpg)
+
+### Invite Members
+
+To invite new members to an empty group:
+
+* Tap on the group name
+* Tap `Invite to the Group`
+* Provide email and tap `Invite`
+
+To invite new members to the group:
+
+* Tap on the group name
+* Tap on the group preferences icon on the top right of the screen
+* Tap `Add People to Group`
+* Provide email and tap `Invite`
+
+Invited members need to check email and accept invite there by clicking on the link
+
+The confirmation window will open and they would need to tap `Accept`
+
+![Invitation android](/gitbook/assets/pylife/groups/invitation_android.jpg)
+
+### Add device
+
+To add device to an empty group:
+
+* Tap on the group name
+* Tap `Add new PyGo`
+* Select device and tap `Add PyGo to Group`
+
+To add device to group:
+
+* Tap on the group name
+* Tap on the group preferences icon on the top right of the screen
+* Tap `Add PyGo to Group`
+* Select device and tap `Add PyGo to Group`
+
+Group details example
+
+![Group details](/gitbook/assets/pylife/groups/group_details.png)

content/pylife/messaging/_index.md

@@ -0,0 +1,36 @@
+---
+title: "Messaging"
+aliases:
+---
+
+## Pylife Messaging Functionality
+
+Once multiple Pylife members have joined a common group, you can send messages between group members.
+
+Messages are sent via LoRa mesh and do not require a cellular connection.
+
+![Messaging iOS Screenshot](/gitbook/assets/pylife/messaging/messaging_ios.jpg)
+
+The indicators next to the message will show the message status.
+
+The first tick indicates that the message has been successfully submitted to the PyGo device for transmission
+
+The second tick indicates that the message has been broadcast through the mesh network
+
+## Private Messaging
+
+By default, all devices communicate using a default encryption key. That means that all devices in a mesh network can read transmitted messages.
+
+If you want to keep messages secure, all devices will have to share a unique mesh key.
+
+You can generate a new random mesh key from the Devices section.
+
+![Default Mesh Key iOS Screenshot](/gitbook/assets/pylife/messaging/default_mesh_key_ios.png)
+
+Generate a new mesh key and deploy it to your device.
+
+All devices you wish to communicate with need to have the same mesh key deployed. Please share with any group memembers you wish to privately communicate with.
+
+![Private Mesh Key iOS Screenshot](/gitbook/assets/pylife/messaging/private_mesh_key_ios.jpg)
+
+> Please note that the private mesh key is per device. You will only be able to communicate with other PyGo devices using the same key.