Skip to content

chore: reference roverd daemons page in docs #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NielsD1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: reference roverd daemons page in docs #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 5 additions & 36 deletions docs/01-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,49 +3,18 @@ import TabItem from '@theme/TabItem';

# Overview

## Purpose

The `battery` service uses the ADS1015 voltage sensor to track the battery charging level. If the voltage drops below a [warning threshold](https://github.com/VU-ASE/battery/blob/0929a05129b1a065dcd423aa189d056eaeec73a6/src/main.go#L24) it will send a warning to active SSH users. If the voltage drops below a [critical threshold](https://github.com/VU-ASE/battery/blob/0929a05129b1a065dcd423aa189d056eaeec73a6/src/main.go#L23) it will shut off the Debix to prevent undercharging in order to improve battery aging.
:::warning[Important]

**NB**: the warning and shutdown thresholds are based on the battery properties (cell count and nominal voltage.)

:::tip

We do not recommend installing this service manually, as `roverd` will automatically check for updates and install it as a daemon service every time the Rover boots.
`battery` is known as a daemon service. You do not need to manage this service yourself. For more information, please visit the page about [`roverd`'s daemon services](https://ase.vu.nl/docs/tutorials/knowing-more/roverd-daemons).

:::

## Installation

To install this service, the latest release of [`roverctl`](https://ase.vu.nl/docs/framework/Software/rover/roverctl/installation) should be installed for your system and your Rover should be powered on.

<Tabs groupId="installation-method">
<TabItem value="roverctl" label="Using roverctl" default>

1. Install the service from your terminal
```bash
# Replace ROVER_NUMBER with your the number label on your Rover (e.g. 7)
roverctl service install -r <ROVER_NUMBER> https://github.com/VU-ASE/battery/releases/latest/download/battery.zip
```

</TabItem>
<TabItem value="roverctl-web" label="Using roverctl-web">
## Purpose

1. Open `roverctl-web` for your Rover
```bash
# Replace ROVER_NUMBER with your the number label on your Rover (e.g. 7)
roverctl -r <ROVER_NUMBER>
```
2. Click on "install a service" button on the bottom left, and click "install from URL"
3. Enter the URL of the latest release:
```
https://github.com/VU-ASE/battery/releases/latest/download/battery.zip
```
The `battery` service uses the ADS1015 voltage sensor to track the battery charging level. If the voltage drops below a [warning threshold](https://github.com/VU-ASE/battery/blob/0929a05129b1a065dcd423aa189d056eaeec73a6/src/main.go#L24) it will send a warning to active SSH users. If the voltage drops below a [critical threshold](https://github.com/VU-ASE/battery/blob/0929a05129b1a065dcd423aa189d056eaeec73a6/src/main.go#L23) it will shut off the Debix to prevent undercharging in order to improve battery aging.

</TabItem>
</Tabs>
**NB**: the warning and shutdown thresholds are based on the battery properties (cell count and nominal voltage.)

Follow [this tutorial](https://ase.vu.nl/docs/tutorials/write-a-service/upload) to understand how to use an ASE service. You can find more useful `roverctl` commands [here](/docs/framework/Software/rover/roverctl/usage)

## Requirements

Expand Down
Loading