Skip to content

Commit

Permalink
Update README.md (#62)
Browse files Browse the repository at this point in the history
* add some usage information about device_map
  and media_map
  • Loading branch information
xx4h authored Oct 19, 2024
1 parent 9d33586 commit 0a2ac41
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ And here we are!
- Set volume on media players
- List all Domains & Domain-Services
- Completion for `bash`, `zsh`, `fish` and `powershell`, auto completing all capable devices
- Add shortcuts/mappings for devices and media files
- Control over short and long names
- Fuzzy matching your devices so you can keep it short

Expand Down Expand Up @@ -194,6 +195,28 @@ handling:
fuzz: false
```
### Device Mapping
```bash
# Set shortcut for `light.livingroom_main` to `lm`
hctl config set device_map.lm light.livingroom_main

# Use shortcut
hctl toggle lm
hctl off lm
hctl brightness lm 50
```

### Media Mapping

```bash
# Set shortcut for `/home/user/sounds/horn.mp3` to `horn`
hctl config set media_map.horn /home/user/sounds/horn.mp3

# Use shortcut
hctl play player1 horn
```

## What's Next / Roadmap

- [ ] Add more actions (like `press` e.g. Buttons, `trigger` e.g. Automations, or `lock` and `unlock` a Lock)
Expand Down

0 comments on commit 0a2ac41

Please sign in to comment.