Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write new credentials.json format in the README #241

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Write new credentials.json format in the README #241

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0750a77
Fix readme
RonanMorgan Feb 7, 2025
7719435
Update README.md
RonanMorgan Feb 11, 2025
7748ad6
Update README.md
RonanMorgan Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 36 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ 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_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 +88,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 +140,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.

Loading