Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
repier37 committed Jun 19, 2023
2 parents be987eb + 275575c commit d75cdb0
Showing 1 changed file with 8 additions and 53 deletions.
61 changes: 8 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,7 @@ This card has been taken from https://github.com/dangreco/threedy and has been m
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Method 1: HACS](#method-1-hacs)
- [Method 2: Manual](#method-2-manual)
- [Config](#config)
- [Graphical](#graphical)
- [Manual](#manual)
- [Required](#required)
- [Optional](#optional)
- [Example Config](#example-config)
- [Custom Theming](#custom-theming)
- [Limitations](#limitations)
Expand Down Expand Up @@ -46,58 +40,19 @@ This card has been taken from https://github.com/dangreco/threedy and has been m

## Installation
---
### Method 1: HACS
1. Open _HACS_ and navigate to _Frontend_ Section
2. Open the Overflow Menu (⋮) in the top right corner and click on _Custom repositories_
3. Paste `https://github.com/repier37/ha-duet-card` into the input field and select `Lovelace` from the dropdown
4. Click the Install Button on the highlighted Card titled _threedy_

### Method 2: Manual

1. Download ```duet-card.js``` from the releases section.
2. Either:
* Move to the ```www``` folder of your Home Assistant instance
* Or copy the file's contents via the file editor.
3. In the Resources section of Lovelace (```Configuration -> Lovelace Dashboards -> Resources```), add ```/local/threedy-card.js``` as a ```JavaScript Module```.
4. Save
5. Add a manual card to your lovelace dashboard using the configuration instructions below.
6. Restart Server management
7. Reload Browser

1. Go to [HACS](http://homeassistant.local:8123/hacs/frontend)
2. Add custom repository
- repo: https://github.com/repier37/ha-duet-card
- Category: Lovelace
- Click add

3. Search "duet"
4. Click the Install Button on the highlighted Card titled _duet_

## Config
---

### Graphical

![graphical](https://github.com/repier37/ha-duet-card/raw/master/screenshots/graphical.png)


### Manual

#### Required

- ```type``` — Always ```'custom:threedy-card'```
- ```base_entity``` — Take the beginning of one of your duet sensors of your printer. Example: for ```sensor.ender_3_v2_current_state``` it would be ```sensor_ender_3_v2```.
- ```name``` — Can be whatever you want!
- ```printer_type``` — Use a printer style: ```'I3' | 'Cantilever' ```
- ```monitored``` — A list of values to monitor throughout the print; gets displayed to the right of the printer.

#### Optional

- ```theme``` — Theme of the card: ```'Default' | 'Neumorphic' ```. Screenshots listed below.
- ```font``` — Specify the font used in the card. By default it is ```sans-serif```.
- ```scale``` — The scale factor of the animated 3D printer view. Try different values until you find one you like.
- ```round_time``` — Specify whether to round durations of time. Defaults to false. ```true | false```
- ```round_temperature``` — Specify whether to round decimal numbers for temperatures. Defaults to false. ```true | false```
- ```temperature_unit``` — Specify which unit of temperature measurement to convert to. ```'F' | 'C' ```
- ```use_24hr``` — Use 24 hour time format instead of 12 hour.
- ```printer_config``` — Use in with ```printer_type``` to set a custom printer style. If omitted, the default for the type will be used. Use [this tool](https://google.com) to create a custom value.
- ```camera_entity``` — Specify the entity ID of the camera entity you want to display **when the printer graphic is clicked**.
- ```light_entity``` — Specify the entity ID of a light you want to toggle for the printer.
- ```power_entity``` — Specify the entity ID of a power switch you want to toggle for the printer.
- ```always_show``` — Override the auto collapse of the card.

## Example Config
---

Expand Down

0 comments on commit d75cdb0

Please sign in to comment.