homebridge-camera-ui

User Interface for RTSP capable cameras.

Usage no npm install needed!

<script type="module">
  import homebridgeCameraUi from 'https://cdn.skypack.dev/homebridge-camera-ui';
</script>

README

camera.ui

npm npm GitHub last commit verified-by-homebridge Discord Donate

camera.ui

camera.ui is a homebridge user interface to control your RTSP capable cameras. It supports almost everything you need for a camera user interface.

  • Live streams on Web
  • Web App with push notifications and more (requires https)
  • Multi-language support
  • CamViews: A resizable, drag & drop camera overview
  • Image Rekognition with AWS
  • Notifications vie Telegram and Webhook
  • Record Snapshot/Video on movement detection
  • User interface with 8 different color themes and darkmode
  • Config UI X Support
  • and much mure...

Supported Languages:

:de: | :gb: | :netherlands:

Installation

sudo npm install -g --unsafe-perm homebridge-camera-ui@latest

Defaults

Once you have installed and configured the plugin you can access the interface via http://localhost:8181.

The default username is master and the default password is master.

Example Config (minimal)

{
   ...
    "platforms": [
        {
            "platform": "CameraUI",
            "name": "CameraUI",
            "port": 8181,
            "cameras": [ ... ]
        }
    ]
}

For a full config.json, please look at Example Config for more details.

Image Rekognition

camera.ui 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.

This makes it possible to analyze every movement before this is stored or sent as a notification.

To use image rekognition, you need to set up a AWS account with an IAM user. More Infos: AWS Image Rekognition

Usage

Login

camera.ui

Dashboard

camera.ui

Camview

camera.ui

Recordings

camera.ui

Notifications

camera.ui

Settings

camera.ui

Supported clients

This plugin has been verified to work with the following apps/systems:

  • iOS > 11
  • Android
  • Windows 10
  • macOS Catalina 10.15
  • Apple Home
  • All 3rd party apps like Elgato Eve etc
  • Homebridge >= v1.1.6
  • Node >= 14

Browser

The following browsers are supported by this plugin:

  • Chrome - latest
  • Firefox - latest
  • Safari - 2 most recent major versions
  • iOS - 2 most recent major versions

MS Internet Explorer (any version) is not supported!

Supported Cameras

Every camera with an RTSP stream!

See Tested Cameras for more info.

FAQ

Please check our FAQ before you open an issue.

Contributing

You can contribute to this homebridge plugin in following ways:

  • Report issues and help verify fixes as they are checked in.
  • Review the source code changes.
  • Contribute bug fixes.
  • Contribute changes to extend the capabilities
  • Pull requests are accepted.

See CONTRIBUTING

Troubleshooting

If you have any issues with the plugin then you can run this plugin in debug mode, which will provide some additional information. This might be useful for debugging issues. Just open your config ui and set debug to true!

https://github.com/SeydX/homebridge-camera-ui/wiki/Debug

License

MIT License

Copyright (c) 2020-2021 SeydX

Permission 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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE 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.