Skip to content

Commit

Permalink
chore: update readme example, remove todos
Browse files Browse the repository at this point in the history
  • Loading branch information
builder555 committed Nov 6, 2024
1 parent 98320cf commit bd78541
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
## Hantek Station - Bench Power Supply Control


![screenshot](screenshot.png)

### Development
## Usage

Prerequisites
### Prerequisites

- docker
- docker-compose

#### Run
### Run

1. Connect your Hantek PSU to your computer (or Raspberry Pi). See [here](https://github.com/builder555/hantek-controller) for options to connect.
1. Download [compose.yml](compose.yml)
1. Run `docker compose up -d` in the same directory
1. Navigate to http://localhost:8000 (or `http://<ip address>:8000` if connecting remotely)

## Development

### Run

If you DO NOT have the psu connected, replace `devices` section from compose.dev.yml with

Expand All @@ -25,15 +33,3 @@ docker compose -f compose.dev.yml up -d --build

UI will run on http://localhost:5173
API runs on http://localhost:8000


TODO:

- [x] Display active voltage/current
- [x] Fetch voltage/current periodically
- [x] Set initial voltage/current
- [x] Display set voltage/current when dragging sliders
- [x] Reconnect WS on connection loss
- [x] Set up CI/CD
- [x] Add docker hub image
- [ ] Add proper tests

0 comments on commit bd78541

Please sign in to comment.