https://github.com/cgsmith/camera-pi
Monitor a security system to see if it is in an alarm, armed, or disarmed state and make the appropriate API calls to the camera system to enable or disable certain privacy masks.
https://github.com/cgsmith/camera-pi
Last synced: 11 months ago
JSON representation
Monitor a security system to see if it is in an alarm, armed, or disarmed state and make the appropriate API calls to the camera system to enable or disable certain privacy masks.
- Host: GitHub
- URL: https://github.com/cgsmith/camera-pi
- Owner: cgsmith
- Created: 2024-06-27T09:06:14.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-04T08:00:43.000Z (over 1 year ago)
- Last Synced: 2025-03-19T21:55:53.858Z (over 1 year ago)
- Language: Python
- Size: 93.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Security: security-camera-privacy-mask.service
Awesome Lists containing this project
README
# Camera Pi
This repository allows for privacy masks to be enabled and disabled. It is intended to be connected to a security
system or some system that can provide an "armed" state and an "alarm" state.
See the [changelog](CHANGELOG.md) if you want to see the differences between versions. Production currently just follows
`master`. It should be switched to tagging when stable.
## security-system-check.py Flowchart
## Environment Setup and Pi Setup
With a Raspberry Pi and a base OS perform the following steps to deploy the code. You should be able to use any
Raspberry Pi. In the next steps you will clone the git repository, setup your Python virtual environment,
download the required packages from PyPi, and then install the service. This assumes you are currently in the
user's home directory and with a subfolder of `security-camera-privacy-mask`
1. `git clone git@bitbucket.org:mount7freiburg/security-camera-privacy-mask.git`
2. `cd security-camera-privacy-mask`
3. `python -m venv .venv`
4. `source .venv/bin/activate`
5. `.venv/bin/pip install -r requirements.txt`
6. `cp .env.example .env`
7. `cp cameras.json.example cameras.json`
8. Make appropriate changes to `.env` file
9. Make appropriate changes to `cameras.json` file
10. Connect wires to GPIO 16 and GPIO 20 for the Raspberry Pi
11. Configure `crontab` to run `deploy.sh` (optional)
1. This will perform a `git pull` and restart the service
> [!NOTE]
> When done with the virtual environment you can type `deactivate` in the terminal.
## Service Setup
1. `cp security-camera-privacy-mask.service /etc/systemd/system/camerapi.service`
2. `sudo systemctl daemon-reload`
3. `sudo systemctl enable camerapi.service`
## Understanding the env vars and cameras.json file
I am using `smtplib` and Gmail for sending emails. You can use any service you want. If you use
a different service you will need to probably configure a different client or SMTP service.
> [!IMPORTANT]
> In Dahua cameras the password has a maximum of 32 characters even though the form lets you input more. Keep the .env
> at 32 characters if your password is longer and it should work
The `.env` file also contains `LOGFILE_PATH` should be the full path to your log file. `LOG_DEBUG` can be any integer
that is typically used for Python logging levels (0, 10, 20, 30... etc). `CAMERA_USERNAME` and `CAMERA_PASSWORD` needs
to be a user that is allowed to make configuration changes. The camera API calls are programmed to call Dahua cameras.
This should also work with Dahua whitelabeled cameras.
The `cameras.json` file contains **channel**, **type**, and **ip**. Only **ip** and **type** are required. The **type**
field can either be `exterior` or `interior`. Channel doesn't do anything but can be used as a reference for you.
## Testing
For testing locally, the program will run a MockGPIO library. This reads `simulated_pins.json` where you can trigger
the PIN input which monitors the burglar alarm system. `SYSTEM_ARMED_PIN` is PIN 16 and `SYSTEM_ALARM_PIN` is PIN 20.
You will need to be on the 192.168.0.x subnet in order to reach the cameras since they are /32 for their subnet.