Skip to content

Commit

Permalink
Fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
RonanMorgan committed Feb 7, 2025
1 parent 5e223a3 commit 0750a77
Showing 1 changed file with 37 additions and 34 deletions.
71 changes: 37 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,8 @@ pip install -e pyro-engine/.
In order to run the project, you will need to specify some information, which can be done using a `.env` file.
This file will have to hold the following information:
- `API_URL`: the URL of the API where to send alerts
- `API_LOGIN`: the login of the user account which will be used to create camera token
- `API_PWD`: the password of the user account
- `CAM_USER`: the username to access the camera
- `CAM_PWD`: the password to access the camera

Expand All @@ -87,39 +89,41 @@ Additionally, you'll need a `./data` folder which contains:
### Example of `credentials.json`:

```json
{
"169.254.40.1": {
"brand": "reolink",
"type": "ptz",
"credentials": [
{
"login": "dummy_login_1",
"password": "dummy_password_1",
"posid": 1
},
{
"login": "dummy_login_2",
"password": "dummy_password_2",
"posid": 2
},
{
"login": "dummy_login_3",
"password": "dummy_password_3",
"posid": 3
}
]
},
"169.254.40.3": {
"brand": "reolink",
"type": "static",
"credentials": [
{
"login": "dummy_login_4",
"password": "dummy_password_4"
}
]
}
}
{
"169.254.7.1": {
"brand": "reolink",
"type": "static",
"token": "",
"azimuth": 322,
"id": 9,
},
"169.254.7.2": {
"brand": "reolink",
"type": "static",
"token": "",
"azimuth": 251,
"id": 10,
},
"169.254.7.3": {
"brand": "reolink",
"type": "ptz",
"token": "",
"id": 11,
"poses": [
0,
1,
2,
3,
],
"azimuths": [
0,
90,
180,
270
]
}
}

```

## Documentation
Expand All @@ -137,4 +141,3 @@ This project is developed and maintained by the repo owner and volunteers from [
## License

Distributed under the Apache 2 License. See [`LICENSE`](LICENSE) for more information.

0 comments on commit 0750a77

Please sign in to comment.