Skip to content

Commit

Permalink
Describing the example commands
Browse files Browse the repository at this point in the history
  • Loading branch information
wberube committed Apr 5, 2024
1 parent 2379a7c commit 3f02b8f
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,32 @@ An all-in-one daemon that exposes an HTTP frontend to

### Examples

Parameters for each region can be passed in one or many calls:
```
curl 192.168.1.17:9000/api/time?ts=1712320920
curl 192.168.1.17:9000/api/osd/0?font=comic&size=32.0&text=Frontdoor
curl "192.168.1.17:9000/api/osd/0?font=comic&size=32.0&text=Frontdoor"
curl 192.168.1.17:9000/api/osd/0?posy=72
```

Supported fonts (sourced from /usr/share/fonts/truetype/) can render Unicode characters:
```
curl 192.168.1.17:9000/api/osd/0?text=Entrée
```

Specifiers starting with a dollar sign are used to represent real-time statistics:
```
curl "192.168.1.17:9000/api/osd/1?text=$B C:$C M:$M"
```

Empty strings are used to clear the regions:
```
curl 192.168.1.17:9000/api/osd/2?text=
```

UTC date and time can be set using Unix timestamps:
```
curl 192.168.1.17:9000/api/time?ts=1712320920
```

### Technical support and donations

Please **_[support our project](https://openipc.org/support-open-source)_** with donations or orders for development or maintenance. Thank you!
Expand Down

0 comments on commit 3f02b8f

Please sign in to comment.