https://github.com/lumeohq/onvif-rs
A native Rust ONVIF client library.
https://github.com/lumeohq/onvif-rs
onvif onvif-client rust
Last synced: about 1 month ago
JSON representation
A native Rust ONVIF client library.
- Host: GitHub
- URL: https://github.com/lumeohq/onvif-rs
- Owner: lumeohq
- License: mit
- Created: 2019-11-20T10:56:22.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-17T17:44:33.000Z (about 1 year ago)
- Last Synced: 2024-04-24T03:57:53.078Z (about 1 year ago)
- Topics: onvif, onvif-client, rust
- Language: Rust
- Size: 940 KB
- Stars: 100
- Watchers: 15
- Forks: 57
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ONVIF-rs
ONVIF-rs is a Rust client library implementation of the ONVIF specification.
## Features
- [x] all ONVIF types are generated from official schema
- [ ] all ONVIF operations are generated from official schema
- [x] operations are async (currently only _tokio_ runtime is supported)
- [x] device discovery on the local network using _WS-discovery_ which is mandatory for all ONVIF devices
- [x] authentication using _WS-Security UsernameToken_ which is mandatory for all ONVIF devices
- [x] zero unsafe
## Usage
Cargo.toml:
```toml
[dependencies]
onvif = { git = "https://github.com/lumeohq/onvif-rs" }
```
## Troubleshooting
If you have an issue with OpenSSL build under Ubuntu, perform the following actions:
```
sudo apt install openssl1.0 libssl1.0.0 libssl1.0-dev
cargo clean
export OPENSSL_LIB_DIR=/usr/lib/x86_64-linux-gnu
export OPENSSL_INCLUDE_DIR=/usr/include/openssl
cargo build
```
## Examples
To [discover](onvif/examples/discovery.rs) devices on the local network:
```shell script
cargo run --example discovery
```
To [inspect and control a camera](onvif/examples/camera.rs):
```shell script
cargo run --example camera -- help
cargo run --example camera -- get-system-date-and-time \
--uri=http://192.168.0.2:8000
cargo run --example camera -- set-hostname \
--uri=http://192.168.0.2:8000 --username=admin --password=qwerty cam2
cargo run --example camera -- get-stream-uris --uri=http://192.168.0.2:8000
```
To [pull events](onvif/examples/event.rs) from a camera, adjust credentials in event.rs and run:
```shell script
cargo run --example event
```
## Dependencies
- XSD -> Rust code generation: [xsd-parser-rs](https://github.com/lumeohq/xsd-parser-rs)
- XML (de)serialization: [yaserde](https://github.com/media-io/yaserde)
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](LICENSE)