Skip to content

Commit 3a9f6ec

Browse files
committed
update documentation
1 parent 8bdb35a commit 3a9f6ec

3 files changed

Lines changed: 19 additions & 3 deletions

File tree

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
[package]
22
name = "prusacam"
3-
version = "0.1.0"
3+
version = "1.0.0"
44
edition = "2021"
5+
license-file = "LICENSE.txt"
6+
description = "This is a simple daemon that periodically grabs images from local webcams and uploads them to Prusa Connect."
7+
homepage = "https://github.com/spotzero/prusacam"
8+
repository = "https://github.com/spotzero/prusacam"
9+
readme = "README.md"
510

611
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
712

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@ Support taking periodic captures from multiple webcams and uploading them to Pru
1010

1111
Supports the connection of a switch or toggle the the Raspberry Pi GPIO to act and an enable/disable of camera uploading.
1212

13-
Support connection of an LED on the Raspberry Pi GPIO to at as an indicator of whether images are being uploaded.
13+
Supports connection of an LED on the Raspberry Pi GPIO to at as an indicator of whether images are being uploaded.
14+
15+
Supports switching the camera on and off with signals.
1416

1517
Currently only supports Linux.
1618

19+
1720
## Getting Started
1821

1922
### Building
@@ -81,6 +84,14 @@ The prusacam binary can just be executed as is.
8184
nohup ./prusacam &
8285
```
8386

87+
### Switching the camera on and off from the command line
88+
89+
`prusacam` will listen for the signal USR1 to act as the camera toggle.
90+
91+
Just run: `killall prusacam -USR1` or `kill $PID -USR1`
92+
93+
When a physical switch is connected and setup, both switches act like a three-way switch.
94+
8495
## Authors
8596

8697
David Pascoe-Deslauriers [@spotzero](https://github.com/spotzero)

0 commit comments

Comments
 (0)