Skip to content
Snippets Groups Projects
Commit 002fedf6 authored by schneider's avatar schneider
Browse files

move info from getting started to UG and upkeep

parent fcf0ef53
No related branches found
No related tags found
No related merge requests found
Pipeline #4902 passed
Stage: trigger
Hide whitespace changes
Inline Side-by-side
en/gettingstarted.md
+ 7
− 51
View file @ 002fedf6
......@@ -8,47 +8,15 @@ You just received your card10 - what now?
[Here](/en/userguide/assemble)'s a step by step guide with a video and pictures for assembling your card10
## card10 navigation
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 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 button.
[![Drawing of card10 with button names](/media/card10buttons.svg)](/media/card10buttons.svg)
## User guide
Have a look at the [General Usage](../userguide/general-usage) section of the [User Guide](../userguide). It will tell you how to:
- Switch the card10 on and off
- Navigate the menu
- Install new apps
- Set your nickname
### Switching your card10 on and off
To switch on card10, briefly press the POWER button. To switch it off again, press and hold down the power button for several seconds (usually this is around three seconds, however for some apps it can take over ten seconds).
### Starting apps
When your card10 is switched on, a short press of the POWER button
brings you to the app menu. You can scroll down with the RIGHT button,
and up with the LEFT button. The SELECT button starts the selected app.
The POWER button starts the app called 'main.py', which is also the app
that will automatically start when you turn on your card10.
### Choosing your personal state
The card10 comes with an app to set your [personal state](/ps). As with the nickname, enter the menu
by pressing the POWER button briefly. This time, select the `personal_state.py` app with the POWER button,
and navigate to your state with the LEFT and RIGHT buttons. Unlike the other apps, the state of the personal
state LED will remain blinking and glowing as you set it in the app.
### USB storage
Your card10 can function similar to a USB stick in its _USB storage mode_. You can use this mode to upload configuration files , firmware updates and MicropPython scripts.
To enter _USB storage mode_, use POWER button to enter the menu. Now use the RIGHT button to select _USB Storage_ and press SELECT. If your card10 is connected to another computer via USB, it will show up as a storage device. Press any button to exit _USB storage mode_ again.
**Important:** Don't forget to eject/unmount the card10 before unplugging it or pressing any button.
If you don't have a _USB Storage_ menu entry or your card10 reboots while using it, you can also use the bootloader to access your card10: First switch off your card10 with a long press of the POWER button. Next, hold down the RIGHT button and the POWER button, until your display shows the text "USB activated. Ready.". Use your operating systems "Eject Safely" functiion or press the POWER button again to exit the bootloader after you are done.
#### Trouble shooting
If operating does not show a file system after activating _USB storage mode_ and attaching it via USB, a few things might be at fault:
- The file system might be corrupted. Please try to create a new FAT file system and copy over the data from a working firmware release.
- The USB cable might be broken. Check if your computer recognized a new device.
And much more!
### Setting your nickname
To set your nickname, create a file called `nickname.txt` on your laptop.
......@@ -60,18 +28,6 @@ If you have successfully uploaded a `nickname.txt` file, your nickname will now
You can also upload a `nickname.json` file instead, to get some more options.
Have a look at the [hatchery](https://badge.team/projects/card10_nickname) for more options of the app.
### Adding apps
The [hatchery](https://badge.team/) also has more apps written by other card10 users. To get these apps on your card10,
you can either use the [app](/app), or you can upload them via USB storage: Download and extract the `tar.gz` files (or download all files individually). Put your card10 in [usb storage mode](/en/gettingstarted#usb-storage), to add the files.
All apps are placed in the `apps` folder. In the `apps` folder, all apps have their own folder, named after the app name (e.g. `apps/app_name`). To add a new app,
create a folder with the name of the app, and then place all files for the app inside this folder.
### Activate BLE
Initially, BLE is disabled for privacy reasons. If you want to use it, you have to activate it first.
* Via the menu: Select the ble.py from the menu and press the SELECT button to enable BLE. The board will restart with activated BLE. Deactivation can be done via the same app.
### Basic ECG howto
Have a look at [how to use the ECG](../ecg/).
......
en/upkeep/filesystem.md 0 → 100644
+ 18
− 0
View file @ 002fedf6
### File system maintainance
#### Read only file system
One possible reason for a read-only filesystem is a set "dirty-bit".
To change this the linux tool fsck can be used.
First the badge needs to be ejected safely, then it needs to be restartet and put back into "USB storage" mode.
The device should not be mounted. Now `lsblk` can help with finding the correct blockdevice.
Then you can check the filesystem with `fsck /dev/sdX` (replace `sdX` with the correct device).
If neccessary the tool will ask if the "dirty bit" should be removed, this needs to be answered with yes.
After this, the problem should be solved.
#### No file system detected
If operating does not show a file system after activating _USB Storage Mode_ and attaching it via USB, a few things might be at fault:
- The file system might be corrupted. Please try to create a new FAT file system and copy over the data from a working firmware release.
- The USB cable might be broken. Check if your computer recognized a new device.
en/userguide/assembly.md
+ 1
− 1
View file @ 002fedf6
......@@ -19,7 +19,7 @@ The main components of your card10 are two electronic boards, the _fundamental_
The _fundamental_ board sits directly on the wrist band, the _harmonic_ board with the display sits on top of it.
If you are curious to learn more about the two boards, you can find a more detailed description on the [hardware overview](../..//hardware-overview/) page.
When unpacking and assembling, make sure to keep your protective foil on the display at first, until you had a look at the
[polarizing display](../../faq/#why-should-i-consider-keeping-the-protective-foil-on-the-display) faq section.
[polarizing display](../../faq/#why-should-i-consider-keeping-the-protective-foil-on-the-display) FAQ section.
[![Harmonic board with glue dot](/media/assemble/IMG_20190819_143216.jpg)](/media/assemble/IMG_20190819_143216.jpg)
......
en/userguide/general-usage.md
+ 34
− 6
View file @ 002fedf6
......@@ -9,9 +9,9 @@ There are four buttons on the card10 _harmonic_ board: On the top left, just abo
## Powering on
To switch on card10, briefly press the `POWER` button.
To switch on card10, briefly press the `POWER` button. After showing you which firmware version is installed, it will launch the [default app](../menu-system#selecting-a-default-app).
## Expected run time
### 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:
......@@ -28,26 +28,54 @@ Let go of the button before the counter reaches 0 and your card10 will go to sta
## Powering off
Sometimes it is necessary to fully power off the card10:
- When storing it for a longer perios to preserve the battery
- When storing it for a longer period 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.
## Starting apps
When your card10 is switched on, a short press of the `POWER` button
brings you to the app menu. You can scroll down with the `RIGHT/DOWN` button,
and up with the `LEFT/UP` button. The `SELECT` button starts the selected app.
The POWER button will always bring you back to the main menu, no matter what the current app is doing.
If you chose "Home" or let the menu time out (after 30 seconds) it will launch the [default app](../menu-system#selecting-a-default-app).
Each time you press the `POWER` button the card10 will be reset into a known state. The LEDs, the sensors and the vibration motor will turn off. The display will turn on.
## Setting your personal state
The card10 comes with an app to set your [personal state](/ps). Enter the menu
by pressing the POWER button briefly. Select the `Personal State` app with the `SELECT` button,
and navigate to your state with the `LEFT/UP` and `RIGHT/DOWN` buttons. Unlike the other apps, the state of the personal
state LED will remain blinking and glowing even after you leave the app.
## 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.
Your card10 can function similar to a USB stick in its _USB Storage Mode_. You can use this mode to upload configuration files, firmware updates and apps. Another way to install apps is via [Bluetooth](../ble) using your mobile phone and the [card10companion app](/app).
First: connect another computer (or mobile phone) via USB to the card10.
Press the `POWER` button to enter the menu and navigate to `USB Storage`. Then use the `SELECT` button to activate the USB storage mode.
[![Going to standby](/media/ug/1-usb-storage.jpg)](/media/ug/1-usb-storage.jpg)
[![Going to standby](/media/ug/1-usb-active.jpg)](/media/ug/1-usb-active.jpg)
If you don't have a `USB Storage` menu entry or your card10 reboots while using it, you can also use the bootloader to access your card10: First put your card10 into [standby](#going-to-standby) with a long press of the `POWER` button. Next, hold down the `RIGHT/DOWN` button and press the `POWER` button, until your display shows the text "USB activated. Ready.". Use your operating systems "Eject Safely" function or press the POWER button again to exit the bootloader after you are done.
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/badge/card10) and select `card10` as the badge model:
**Important:** Don't forget to eject/unmount the card10 before unplugging it or pressing any button.
To get additional applications please go to the [badge.team hatchery](https://badge.team/badge/card10) and select `card10` as the badge model:
[![Going to standby](/media/ug/1-badge-team.png)](https://badge.team/badge/card10)
You can now browse the different applications. After selecting one, you can press "Download latest egg (tar.gz)" 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:
![Going to standby](/media/ug/1-download-egg.png)
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.
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, the file system being read-only or your operating system talking about a corrupted file system, go to the [file system maintenance page](../../upkeep/filesystem) and follow the instructions to repair the file system.
en/userguide/general-usage.md.bak
+ 49
− 13
View file @ 002fedf6
---
title: General 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.
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/UP` 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/DOWN` button.
[![Drawing of card10 with button names](/media/card10buttons.svg)](/media/card10buttons.svg)
## Powering on
To switch on card10, briefly press the `POWER` button.
To switch on card10, briefly press the `POWER` button. After showing you which firmware version is installed, it will launch the [default app](../menu-system#selecting-a-default-app).
## 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.
### 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. In this mode it draws very little power and should last multiple months with a full battery.
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 standy state simple press the `POWER` button for a few seconds until you see this screen:
To go the standby mode 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.
[![Going to standby](/media/ug/1-standby.jpg)](/media/ug/1-standby.jpg)
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 time to preserve the battery
- 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.
## Starting apps
When your card10 is switched on, a short press of the `POWER` button
brings you to the app menu. You can scroll down with the `RIGHT/DOWN` button,
and up with the `LEFT/UP` button. The `SELECT` button starts the selected app.
The POWER button will always bring you back to the main menu, no matter what the current app is doing.
If you chose "Home" or let the menu time out (after 30 seconds) it will launch the [default app](../menu-system#selecting-a-default-app).
Each time you press the `POWER` button the card10 will be reset into a known state. The LEDs, the sensors and the vibration motor will turn off. The display will turn on.
## Setting your personal state
The card10 comes with an app to set your [personal state](/ps). Enter the menu
by pressing the POWER button briefly. Select the `Personal State` app with the `SELECT` button,
and navigate to your state with the `LEFT/UP` and `RIGHT/DOWN` buttons. Unlike the other apps, the state of the personal
state LED will remain blinking and glowing even after you leave the app.
## 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.
Your card10 can function similar to a USB stick in its _USB Storage Mode_. You can use this mode to upload configuration files, firmware updates and apps. Another way to install apps is via [Bluetooth](../ble) using your mobile phone and the [card10companion app](/app).
First: connect another computer (or mobile phone) via USB to the card10.
Press the `POWER` button to enter the menu and navigate to `USB Storage`. Then use the `SELECT` button to activate the USB storage mode.
[![Going to standby](/media/ug/1-usb-storage.jpg)](/media/ug/1-usb-storage.jpg)
[![Going to standby](/media/ug/1-usb-active.jpg)](/media/ug/1-usb-active.jpg)
If you don't have a `USB Storage` menu entry or your card10 reboots while using it, you can also use the bootloader to access your card10: First put your card10 into [standby](#going-to-standby) with a long press of the `POWER` button. Next, hold down the `RIGHT/DOWN` button and press the `POWER` button, until your display shows the text "USB activated. Ready.". Use your operating systems "Eject Safely" function or press the POWER button again to exit the bootloader after you are done.
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:
**Important:** Don't forget to eject/unmount the card10 before unplugging it or pressing any button.
To get additional applications please go to the [badge.team hatchery](https://badge.team/badge/card10) and select `card10` as the badge model:
[![Going to standby](/media/ug/1-badge-team.png)](https://badge.team/badge/card10)
You can now browse the different applications. After selecting one, you can press "Download latest egg (tar.gz)" 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:
![Going to standby](/media/ug/1-download-egg.png)
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 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.
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.
If you experience issues with apps not working, weird files showing up, the file system being read-only or your operating system talking about a corrupted file system, go the [file system maintainance page](../../upkeep/filesystem) and follow the instructions to repair the file system.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment