Commit dd504d42 authored by schneider's avatar schneider
Browse files

first stab at user guide

parent 6ddc5dd9
Pipeline #4885 passed with stage
in 7 seconds
---
title: User Guide
---
# **THIS USER GUIDE IS IN ITS EARLY STATE OF CONSTRUCTION. IT IS INCOMPLETE. **
The user guide of the card10 is divided into a few sections. Here is an overview of the different sections and what they cover:
### [Assembly](assembly):
- Assembly video
- Instructions how to assemble the card10
### [General usage](general-usage):
- Buttons
- Powering on
- Expected run time
- Going to standby
- Powering off
- Installing apps via USB
### [Bluetooth Low Energy (BLE)](ble):
- Pairing
- How to check if a device is connected
- Installing companion app on android
- Installing companion app on ios
- Using characteristics via BLE
- Using the light sensor with Phyphox
### [The menu system](menu-system):
- How to select a default app
### [Using the card10 as a watch](watch):
- Setting the time without BLE
- Setting the time with BLE
- Apps which implement watch features
### [Using the card10's ECG functionality](ecg):
- Configuring the ECG app correctly
- Using it correctly
- Taking a recording
- Installing wired connections
### [Cases](cases):
- 3D printed cases
- Other variants
---
title: User Guide
---
The user guide of the card10 is divided into a few sections. Here is an overview of the different sections and what they cover:
### Assembling:
- Assembly video
- Instructions how to assemble the card10
### [General usage](general-usage)
- Buttons
- Powering on
- Expected run time
- Going to standby
- Powering off
- Installing apps via USB
### Bluetooth Low Energy (BLE):
- Pariring
- How to check if a device is connected
- Installing companion app on android
- Installing companion app on ios
- Using characteristics via BLE
- Using the light sensor with PhyFox
### Menu system
- How to select a default app
### Using the card10 as a watch
- Setting the time without BLE
- Setting the time with BLE
- Apps which implement watch features
### Using the card10's ECG functionality
- Configuring the ECG app correctly
- Using it correctly
- Taking a recording
- Installing wired connections
### Cases
- 3D printed cases
- Other variants
---
title: "0: Assembly"
---
---
title: "2: Bluetooth Low Energy (BLE)"
---
---
title: "6: Cases"
---
---
title: "5: ECG usage"
---
---
title: "1: General Usage"
---
## Buttons
There are four buttons on the card10 _harmonic_ board: On the top left, just above the USB-C connector is the `POWER` button. Below is the `LEFT/DOWN` button. The buttons on the right side are closer together. On this side, the top button is the `SELECT` button, the one below it is the `RIGHT/UP` button.
[![Drawing of card10 with button names](/media/card10buttons.svg)](/media/card10buttons.svg)
## Powering on
To switch on card10, briefly press the `POWER` button.
## Expected run time
With the default watch face and the current firmware (version 1.16) , a card10 should last around 24 hours. It will go into standby mode when the battery reaches a critically low level. In standby mode it continues to keep the time for multiple days. Even with an "empty" battery.
The card10 signals going to sleep with this screen and by turning on the vibration motor:
## Going to standby
The card10 has a standby mode in which it continues to keep the current time and date. In this mode it draws very little power and should last multiple months with a full battery.
To go the standby mode press the `POWER` button for a few seconds until you see this screen:
Let go of the button before the counter reaches 0 and your card10 will go to standby. If you keep pressing until the counter reaches 0, you card10 will hard turn off and lose the current time and date.
## Powering off
Sometimes it is necessary to fully power off the card10:
- When storing it for a longer perios to preserve the battery
- To reset it if the firmware is not able to go to standby anymore
- To reduce power consumption if a debugger was attached before
To fully power of the card10, press the `POWER` button for at least 10 seconds. If the firmware is working, you will see the card10 counting down until 0 and then turn off. If the firmware is not working, slowly count to 10 and let go of the button. Afterwards you can turn on the card10 as usual again.
## Installing apps via USB
One way to install applications on the card10 is via its USB interface. Press the `POWER` button to enter the menu and navigate to `USB STORAGE`. Then use the `SELECT` button to activate the USB storage mode.
You can now use your computer to access the internal file system of the card10. The `apps` folder contains all applications which are installed on the card10. The card10 comes with a few applications already pre-installed which you can find as well in the `apps` folder.
To get additional applications please go to [badge.team](https://badge.team) and select `card10` as the badge model:
You can now browse the different applications. After selecting one, you can press "Download latest zip" which contains the files needed to execute the app on your card10. Simply download the file and extract its contents into the `apps` folder on the card10. You can also update already installed applications this way.
After transferring the application files don't forget to use the "eject safely" functionality of your operating system to make sure all data gets written to the card10. If you experience issues with apps not working, weird files showing up or your operating system talking about a corrupted file system, go the [upkeep] and follow the instructions to repair the file system.
---
title: General Usage
---
## Buttons
There are four buttons on the card10 _harmonic_ board: On the top left, just above the USB-C connector is the `POWER` button. Below is the `LEFT/DOWN` button. The buttons on the right side are closer together. On this side, the top button is the `SELECT` button, the one below it is the `RIGHT/UP` button.
[![Drawing of card10 with button names](/media/card10buttons.svg)](/media/card10buttons.svg)
## Powering on
To switch on card10, briefly press the `POWER` button.
## Expected run time
With the default watch face and the current firmware (version 1.16) , a card10 should last around 24 hours. It will go into standby mode when the battery reaches a critically low level. In standby mode it contiues to keep the time for multiple days. Even with an "empty" battery.
The card10 signals going to sleep with this screen and by turning on the vibration motor:
## Going to standby
The card10 has a standby mode in which it continues to keep the current time. In this mode it draws very little power and should last multiple months with a full battery.
To go the standy state simple press the `POWER` button for a few seconds until you see this screen:
Now simply let go of the button and your card10 is in standby.
## Powering off
Sometimes it is necessary to fully power off the card10:
- When storing it for a longer time to preserve the battery
- To reset it if the firmware is not able to go to standby anymore
- To reduce power consumption if a debugger was attached before
To fully power of the card10, press the `POWER` button for at least 10 seconds. If the firmware is working, you will see the card10 counting down until 0 and then turn off. If the firmware is not working, slowly count to 10 and let go of the button. Afterwards you can turn on the card10 as usual again.
## Installing apps via USB
One way to install applications on the card10 is via its USB interface. Press the `POWER` button to enter the menu and navigate to `USB STORAGE`. Then use the `SELECT` button to activate the USB storage mode.
You can now use your computer to access the internal file system of the card10. The `apps` folder contains all applications which are installed on the card10. The card10 comes with a few applications already pre-installed which you can find as well in the `apps` folder.
To get additional applications please go to [badge.team](https://badge.team) and select `card10` as the badge model:
You can now browse the different applications. After selecting one, you can press "Download latest zip" which contains the files needed to exeute the app on your card10. Simply download the file and extract its contents into the `apps` folder on the card10. You can also update already installes applications this way.
After transfering the application files don't forgett to use the "eject safely" functionality of your operating system to make sure all data gets written to the card10. If you expirence issues with apps not working, weird files showing up or your operating system talking about a corrupted file system, go the [upkeep] and follow the instructions to repair the file system.
---
title: "3: The menu system"
---
---
title: "4: Watch usage"
---
......@@ -173,7 +173,7 @@
style="text-align:end;text-anchor:end;stroke-width:0.26458332"
y="942.59967"
x="240.28717"
sodipodi:role="line">LEFT</tspan></text>
sodipodi:role="line">LEFT/DOWN</tspan></text>
<text
id="text8109-5"
y="887.44299"
......@@ -195,7 +195,7 @@
style="text-align:start;text-anchor:start;stroke-width:0.26458332"
y="953.84882"
x="798.30328"
sodipodi:role="line">RIGHT</tspan></text>
sodipodi:role="line">RIGHT/UP</tspan></text>
<g
transform="matrix(-21.678507,0,0,21.678507,4575.1855,-1034.2757)"
id="g9304">
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment