Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
niwla23 committed Oct 20, 2021
1 parent 366ac6b commit b74f914
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 30 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@ A custom dashboard for openHAB.
![Screenshot](screenshots/screen1.png)

## Usage
### pre-generated
- download the latest release
- unpack it to your webroot
- put your config in `configs` folder. You can use the existing files as examples. (you can also have it somewhere else if CORS is allowed)
- go to `http:<host>:<port>/config` and set the values
- enjoy your dashboard

### Self generated

- clone this repo
- run `yarn`
- put your config in static/configs folder. (you can also have it somewhere else if CORS is allowed)
Expand All @@ -11,6 +20,13 @@ A custom dashboard for openHAB.
- go to `http:<host>:<port>/config` and set the values
- enjoy your dashboard

## Features
### Supported Item types
All items are supported for display. The listed items have a special implementation for either read or write.
- Dimmer
- Number
- Switch
- Planned: Color

## Build Setup

Expand Down
30 changes: 0 additions & 30 deletions static/configs/alwin.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,36 +22,6 @@
"label": "LED hinten rechts",
"item_name": "alwinrgbregalhinten_white",
"suffix": null
},
{
"label": "Netz",
"item_name": "E3DC_Netz",
"suffix": "W"
},
{
"label": "Akkustand",
"item_name": "E3DC_SOC",
"suffix": "%"
},
{
"label": "Autarkie",
"item_name": "E3DC_Autarkie",
"suffix": "%"
},
{
"label": "Eigenstrom",
"item_name": "E3DC_Eigen",
"suffix": "%"
},
{
"label": "Tor Zeitsteuerung",
"item_name": "gate_schedule_active",
"suffix": null
},
{
"label": "Tor",
"item_name": "alwinrgbregalhinten_white",
"suffix": "%"
}
]
}
Expand Down

0 comments on commit b74f914

Please sign in to comment.