Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seydx committed Jan 9, 2022
1 parent 5bd2607 commit 4fadb45
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 4 deletions.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,17 @@ The default username is ``master`` and the default password is ``master``. When

The cameras that are included in camera.ui can easily be exposed to Apple Home via Homebridge.

To do this, please install `homebridge-config-ui-x` and search for the plugin `homebridge-camera-ui` and install it.
To do this, please install [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x) and search for the plugin [homebridge-camera-u](https://github.com/seydx/homebridge-camera-ui) and install it.

<img src="https://github.com/SeydX/camera.ui/blob/master/images/homebridge/homebridge_search.png" align="center" alt="camera.ui">

Your database, if you have not changed the path, will remain the same. However you have to copy the content of `config.json` and paste it via homebridge-config-ui-x into the config.json block of homebridge-camera-ui.

Homebridge-config-ui-x offers some more config parameter to eg. enable HSV, motion sensors, motion switches and more. Please take a look at the `example-config.json`


*Note:* homebridge-camera-ui >= v5.0.0 is compatible with camera.ui. Version 5 is still in beta phase and will be released very soon. [v5.0.0](https://github.com/seydx/homebridge-camera-ui/pull/255)

# Motion detection

camera.ui offers a variety of options to detect and process motion.
Expand Down Expand Up @@ -142,6 +147,39 @@ camera.ui is a full-featured PWA (Progressive Web Application). The PWA offers s

To "enable" PWA you need to run the page over HTTPS. In the config.json you can provide your own SSL key and certificate to run camera.ui over HTTPS.

# Service Mode

To let camera.ui run permanently in the background, you can use it in `Service Mode`.

Create a new file named `camera.ui.default` and paste the following into it:

```
CAMERA_UI_OPTS=-D -C -T -S "/home/pi/Desktop/.camera.ui/"
CUI_STORAGE_PATH="/home/pi/Desktop/.camera.ui/"
DISABLE_OPENCOLLECTIVE=true
```

Please make sure to change the path if necessary. Then create another file named `camera.ui.service` and add the following:

```
[Unit]
Description=camera.ui
After=syslog.target network-online.target
[Service]
Type=simple
User=pi
EnvironmentFile=/etc/default/camera.ui
ExecStart=/home/pi/Desktop/camera.ui/bin/camera.ui.js $CAMERA_UI_OPTS
Restart=always
RestartSec=5
KillMode=process
[Install]
WantedBy=multi-user.target
```

# Supported clients

This plugin has been verified to work with the following apps/systems:
Expand Down
2 changes: 0 additions & 2 deletions misc/camera.ui.default

This file was deleted.

4 changes: 4 additions & 0 deletions misc/service/camera.ui.default
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
CAMERA_UI_OPTS=-D -C -T -S "/home/pi/Desktop/camera.ui/test/camera.ui"
CUI_STORAGE_PATH="/home/pi/Desktop/camera.ui/test/camera.ui"

DISABLE_OPENCOLLECTIVE=true
2 changes: 1 addition & 1 deletion misc/camera.ui.service → misc/service/camera.ui.service
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ After=syslog.target network-online.target
Type=simple
User=pi
EnvironmentFile=/etc/default/camera.ui.default
ExecStart=/usr/local/bin/camera.ui.js $CAMERA_UI_OPTS
ExecStart=/home/pi/Desktop/camera.ui/bin/camera.ui.js $CAMERA_UI_OPTS
Restart=always
RestartSec=5
KillMode=process
Expand Down
File renamed without changes.

0 comments on commit 4fadb45

Please sign in to comment.