![](\"https://github.com/SeydX/camera.ui/blob/master/images/logo.png\"){kind=logo}
\r\n\r\n \r\n
![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/dashboard.png\")
\r\n\r\n### Cameras\r\n\r\nHere are all cameras listed by room and show the current snapshot as a cover sheet\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/cameras.png\")
\r\n\r\n### Camera\r\n\r\nIf you select a camera you can watch the livestream directly in the browser. With the camera.ui player you can pause the stream, turn audio on/off or reload the stream.\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/camera.png\")
\r\n\r\n### Recordings\r\n\r\nAll images or videos recorded by motion are listed here. If AWS Rekognition is used, the label for the recording is also displayed, as well as the date and time. Using the filter function, the recordings can be filtered as desired\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/recordings.png\")
\r\n\r\n### Notifications\r\n\r\nAll motion events as well as system messages can be viewed here. Each notification has one or more labels to better catagorize them. The filter function can also be used to filter the notifications as desired.\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/notifications.png\")
\r\n\r\n### Camview\r\n\r\nCamview displays all camera streams in tiles, hiding everything unnecessary. Camview is great for giving a direct insight into the cameras. Also here the streams can be paused by the camera.ui video player, audio can be switched on/off, streams can be reloaded or viewed in full mode.\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/camview.png\")
\r\n\r\n### Log\r\n\r\nAll events that occur in the backend can be monitored via the built-in log. In addition, the log can be also be cleared or downloaded here.\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/console.png\")
\r\n\r\n### Config\r\n\r\nUsing the built-in editor you can easily edit your config.json. In addition, any errors are immediately displayed and thus avoided to save a faulty config.json\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/config.png\")
\r\n\r\n### Utilization\r\n\r\n\"Utilization\" shows you a graphical overview of the system utilization. Here you can see in real time how high the CPU utilization is, how high the CPU temperature is and how much memory is still free.\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/utilization.png\")
\r\n\r\n### Settings\r\n\r\nOn the settings page you can make ALL settings regarding your config.json and database. All parameters defined in config.json are directly configurable from this page. If camera.ui runs via \"Homebridge\" you can also set Homebridge relevant parameters here.\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/settings.png\")
\r\n\r\n## HomeKit\r\n\r\nThe cameras that are included in camera.ui can easily be exposed to Apple Home via Homebridge.\r\n\r\nTo do this, please install [homebridge-config-ui-x](https://github.com/oznu/homebridge-config-ui-x) and search for the plugin [homebridge-camera-ui](https://github.com/seydx/homebridge-camera-ui) and install it.\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/homebridge/homebridge_search.png\")
\r\n\r\nIf you run camera.ui via Homebridge, then the interface will also be started automatically on every startup. An additional `Service Mode` is no longer needed.\r\n\r\nIf you have used camera.ui before WITHOUT Homebridge and then use it with Homebridge, then the database must be recreated and also the config is taken over by Homebridge. You have to add the cameras again to Homebridge. After restarting Homebridge, the cameras will be also available on camera.ui\r\n\r\nHomebridge-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`\r\n\r\n_Note:_ homebridge-camera-ui >= v5.0.0 is compatible with camera.ui.\r\n\r\n## Motion detection\r\n\r\ncamera.ui offers a variety of options to detect and process motion.\r\n\r\n### Videoanalysis\r\n\r\n![\"camera.ui\"](\"https://github.com/SeydX/camera.ui/blob/master/images/browser/videoanalysis.png\")
\r\n\r\nWith this option camera.ui connects to the stream and compares frame by frame if there are changes. The zones and sensitivity can be set in the interface.\r\n\r\n### HTTP\r\n\r\nIf the HTTP server is enabled for motion detection, calling the link can easily trigger motion.\r\n\r\nExample:\r\n\r\n`http://localhost:8123/motion?My+Camera`\r\n\r\n### MQTT\r\n\r\nIf you have set up the MQTT client (Settings > System > MQTT), you can set the required parameters such as \"Motion Topic\", \"Message\" etc. via the interface (Settings > Cameras > MQTT).\r\n\r\n**Motion Topic**: The MQTT topic to watch for motion alerts. The topic (prefix/suffix) should be unique, it will be used to assign the motion detected message to the desired camera.\r\n\r\n**Motion Message**: The message to watch for to trigger motion alerts.\r\n\r\nThe message can be a simple \"string\" (e.g. \"ON\"/\"OFF) or a JSON object. If the MQTT message is a JSON object like:\r\n\r\n```json\r\n{\r\n \"id\": \"test\",\r\n \"event\": {\r\n \"time\": 1234567890,\r\n \"state\": true\r\n }\r\n}\r\n```\r\n\r\nThen define the exact parameter under \"Motion Message\" so that camera.ui can read from it, eg:\r\n\r\n```json\r\n\"motionMessage\": {\r\n \"event\": {\r\n \"state\": true\r\n }\r\n}\r\n```\r\n\r\n### SMTP\r\n\r\nIf the SMTP server is turned on and your camera is able to send an email when motion is detected, you can easily trigger motion through it, eg:\r\n\r\n`From: My+Camera@camera.ui`\r\n`To: My+Camera@camera.ui`\r\n\r\nPlease note that the camera.ui SMTP server is set in the camera settings (ip/port).\r\n\r\n### FTP\r\n\r\nIf your camera is able to upload an image when motion is detected, then you can select the camera.ui FTP server as the destination. Very important here is. The path you enter via the camera's own settings page must be the camera name as defined in config.\r\n\r\nEvery time the camera tries to connect to the server, the camera.ui detects and takes the entered path to determine the camera.\r\n\r\n## Image Rekognition\r\n\r\ncamera.ui also uses image rekognition with Amazon Web Services to analyse, detect, remember and recognize objects, scenes, and faces in images. You can enable for each camera the image rekogniton and you can even set labels for each camera. For each object, scene, and concept the API returns one or more labels. Each label provides the object name. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.\r\n\r\nThis makes it possible to analyze every movement before this is stored or sent as a notification.\r\n\r\nTo use image rekognition, you need to set up a AWS account with an IAM user. More Infos: [AWS Image Rekognition](https://aws.amazon.com/rekognition/?nc1=h_ls&blog-cards.sort-by=item.additionalFields.createdDate&blog-cards.sort-order=desc)\r\n\r\n## Notifications\r\n\r\ncamera.ui supports numerous notification options. Each of them can be conveniently set via the interface.\r\n\r\nSince push notifications only work conditionally for websites (see PWA), you can easily work around this via third-party providers.\r\n\r\nThese would be e.g.\r\n\r\n- Telegram\r\n- Webhook\r\n- Alexa\r\n- Third party providers that support Alexa\r\n\r\nVia Telegram, you even have the option to send picture or video along with text messages.\r\n\r\n## PWA\r\n\r\ncamera.ui is a full-featured PWA (Progressive Web Application). The PWA offers several advantages over a normal web page. Via Windows/macOS/Android the browser can directly send you push notifications natively. The handling of the page becomes much faster and much more.\r\n\r\nTo \"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.\r\n\r\n## Service Mode\r\n\r\nTo let camera.ui run permanently in the background, you can use it in `Service Mode`.\r\n\r\nCreate a new file named `camera.ui.default` and paste the following into it:\r\n\r\n```\r\nCAMERA_UI_OPTS=-D -C -T -S \"/home/pi/Desktop/.camera.ui/\"\r\nCUI_STORAGE_PATH=\"/home/pi/Desktop/.camera.ui/\"\r\n\r\nDISABLE_OPENCOLLECTIVE=true\r\n```\r\n\r\nPlease make sure to change the path if necessary. Put the camera.ui.default file to `/etc/default/` folder\r\n\r\nThen create another file named `camera.ui.service` and add the following:\r\n\r\n```\r\n[Unit]\r\nDescription=camera.ui\r\nAfter=syslog.target network-online.target\r\n\r\n[Service]\r\nType=simple\r\nUser=pi\r\nEnvironmentFile=/etc/default/camera.ui\r\nExecStart=/home/pi/Desktop/camera.ui/bin/camera.ui.js $CAMERA_UI_OPTS\r\nRestart=always\r\nRestartSec=5\r\nKillMode=process\r\n\r\n[Install]\r\nWantedBy=multi-user.target\r\n```\r\n\r\nPut the camera.ui.service file into `/etc/systemd/system/` folder.\r\n\r\nType following commands to enable/start the service\r\n\r\n1. `sudo systemctl daemon-reload`\r\n2. `sudo systemctl enable camera.ui`\r\n3. `sudo systemctl start camera.ui`\r\n\r\nYou can always watch the log with following command:\r\n\r\n`sudo journalctl -f -u camera.ui`\r\n\r\n## Supported clients\r\n\r\nThis plugin has been verified to work with the following apps/systems:\r\n\r\n- iOS\r\n- Android\r\n- Windows 10\r\n- macOS Catalina 10.15\r\n- Node >= 14\r\n\r\n### Browser\r\n\r\nThe following browsers are supported by this plugin:\r\n\r\n- Chrome - latest\r\n- Firefox - latest\r\n- Safari - 2 most recent major versions\r\n- iOS - 2 most recent major versions\r\n\r\n_MS Internet Explorer (any version) is not supported!_\r\n\r\n## Supported Cameras\r\n\r\nEvery camera with an active RTSP stream!\r\n\r\n### Camera Settings\r\n\r\nYou should make the following configuration for your camera via the camera's own settings page. These settings work best.\r\n\r\n- Video: H264 (Others like mjpeg also work, but need to be reencoded and would be of limited use for prebuffering)\r\n- Audio: AAC (Other codecs could also work through reencoding)\r\n- Resolution: Freely selectable, but 1920x1080 works best with Apple HSV\r\n- 2 Mbit variable bitrate (up to 6Mbit may work)\r\n- 25 FPS (30 FPS prefered).\r\n- Keyframe interval is 4 seconds. Frame Interval = FPS _ 4 => 30 _ 4 = 120\r\n\r\n## API\r\n\r\ncamera.ui has a REST API that is primarily used by the web client (i.e. the UI), but can also be consumed by other apps or personal scripts.\r\n\r\nYou can access the API reference via your local instance by going to /swagger\r\n\r\nFor example http://[IP]:8081/swagger\r\n\r\n## FAQ\r\n\r\nPlease check our [FAQ](https://github.com/SeydX/camera.ui/wiki/FAQ) before you open an issue.\r\n\r\n## Contributing\r\n\r\nYou can contribute to this in following ways:\r\n\r\n- Report issues and help verify fixes as they are checked in.\r\n- Review the source code changes.\r\n- Contribute bug fixes.\r\n- Contribute changes to extend the capabilities\r\n- Pull requests are accepted.\r\n\r\nSee [CONTRIBUTING](https://github.com/SeydX/camera.ui/blob/master/CONTRIBUTING.md)\r\n\r\n## Troubleshooting\r\n\r\nIf you have any issues then you can run camera.ui in debug mode, which will provide some additional information. This might be useful for debugging issues. Open the interface > settings > system >\r\n\r\nhttps://github.com/SeydX/camera.ui/wiki/Debug\r\n\r\n## Wiki\r\n\r\nBefore you open a new issue, please read carefully the wiki: https://github.com/seydx/homebridge-camera-ui/wiki\r\n\r\n## License\r\n\r\n### MIT License\r\n\r\nCopyright (c) 2020-2022 seydx\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r\n\r\nOffice Skid:\r\nInfraspec:iis/MIUtrailer123\r\nNVR:admin/MIUtrailer123\r\nHomebridge:iis/MIUtrailer123\r\n","readmeFilename":"README.md"}