Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vannadii/reecam-monitor
A NodeJS Commander CLI and ExpressJS, React web portal for monitoring and viewing ReeCam and SoSoCam IP camera devices on a local network.
https://github.com/vannadii/reecam-monitor
camera commander expressjs reecam sosocam
Last synced: about 1 month ago
JSON representation
A NodeJS Commander CLI and ExpressJS, React web portal for monitoring and viewing ReeCam and SoSoCam IP camera devices on a local network.
- Host: GitHub
- URL: https://github.com/vannadii/reecam-monitor
- Owner: VannaDii
- License: cc0-1.0
- Created: 2021-12-03T00:03:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-29T01:12:03.000Z (almost 3 years ago)
- Last Synced: 2024-04-25T00:45:34.624Z (8 months ago)
- Topics: camera, commander, expressjs, reecam, sosocam
- Language: TypeScript
- Homepage:
- Size: 5.61 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ReeCam-Monitor
For monitoring ReeCam and SoSoCam IP camera devices on a local network.
## How To Use
1. Create a `.env` file locally with:
```sh
REECAM_IP=192.168.1.122 # The IP Address of a camera on your network
REECAM_PWD= # The password for the specified camera on your network
```
2. `yarn install`
3. `yarn test`
You should see something like:
```
PASS src/utils.test.ts
PASS src/reecam.test.ts
-------------|---------|----------|---------|---------|-------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
-------------|---------|----------|---------|---------|-------------------
All files | 25.36 | 32.43 | 33.89 | 26.17 |
index.ts | 0 | 0 | 0 | 0 | 3-103
monitor.ts | 0 | 0 | 0 | 0 | 1-108
recorder.ts | 0 | 0 | 0 | 0 | 1-57
reecam.ts | 95.34 | 83.33 | 89.47 | 95.34 | 55-59
utils.ts | 91.66 | 66.66 | 100 | 100 | 12
-------------|---------|----------|---------|---------|-------------------
Test Suites: 2 passed, 2 total
Tests: 16 passed, 16 total
Snapshots: 0 total
Time: 7.443 s
Ran all test suites.
✨ Done in 8.62s.
```
4. `ipcams --help`
You should see something like:
```
Usage: ipcams [options] [command]
Options:
-V, --version output the version number
-h, --help display help for command
Commands:
add Adds a configured camera. Password will be requested securely.
list Shows the configured IP cameras.
remove Removes a configured IP camera.
monitor Monitor online cameras
help [command] display help for command
```
5. `ipcams add admin|visitor`
This will securely prompt your for a password and store the data encoded in a local file.
6. `ipcams monitor`
This will start monitoring and producing event related content from camera alarm periods.
7. `yarn serve`
This will start the monitor and local web server on port `8080`. You can navigate to the web app using `http://localhost:8080/app` in a browser or access the API at `http://localhost:8080/api`
8. `yarn start`
This will start the monitor and local web server on port `8080` in a docker container, using the `docker-compose.yml` file. You can navigate to the web app using `http://localhost:8080/app` in a browser or access the API at `http://localhost:8080/api`
## Docker Compose Example
```yaml
version: '3.8'
services:
reecam-web:
image: giocirque/reecam-web:latest
network_mode: bridge
restart: always
environment:
- PUBLIC_URL=app
- PUBLIC_HOST=http://localhost:5555
volumes:
- /array/data/ipcams:/reecam/.ipcams
ports:
- 5555:8080
```