npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

iobroker.unifi-protect-nvr

v1.1.1

Published

Unifi Protect Adapter based on the unifi-protect library from hjdhjd

Downloads

77

Readme

ioBroker.unifi-protect-nvr

NPM version Downloads Number of Installations Current version in stable repository

NPM

Tests: Test and Release

unifi-protect-nvr adapter for ioBroker

Unifi Protect Adapter for ioBroker based on the great unifi-protect library from hjdhjd.
This adapter uses the websocket interface to receive real-time information from the unifi-protect application

Tested Devices

The following devices have been successfully tested with the adapter.

| Model | Type | Success | | ----------------- | :----: | :-----: | | UDM-PRO | NVR | ✔ | | UDM-SE | NVR | ✔ | | G3 Flex | Camera | ✔ | | G4 Dome | Camera | ✔ | | G4 Instant | Camera | ✔ | | G5 Pro + Enhancer | Camera | ✔ | | G5 Turret Ultra | Camera | ✔ | | UP Sense | Sensor | ✔ |

Developer manual

This section is intended for the developer. It can be deleted later.

DISCLAIMER

Please make sure that you consider copyrights and trademarks when you use names or logos of a company and add a disclaimer to your README. You can check other adapters for examples or ask in the developer community. Using a name or logo of a company without permission may cause legal problems for you.

Getting started

You are almost done, only a few steps left:

  1. Create a new repository on GitHub with the name ioBroker.unifi-protect-nvr

  2. Initialize the current folder as a new git repository:

    git init -b main
    git add .
    git commit -m "Initial commit"
  3. Link your local repository with the one on GitHub:

    git remote add origin https://github.com/Scrounger/ioBroker.unifi-protect-nvr
  4. Push all files to the GitHub repo:

    git push origin main
  5. Add a new secret under https://github.com/Scrounger/ioBroker.unifi-protect-nvr/settings/secrets. It must be named AUTO_MERGE_TOKEN and contain a personal access token with push access to the repository, e.g. yours. You can create a new token under https://github.com/settings/tokens.

  6. Head over to main.js and start programming!

Best Practices

We've collected some best practices regarding ioBroker development and coding in general. If you're new to ioBroker or Node.js, you should check them out. If you're already experienced, you should also take a look at them - you might learn something new :)

Scripts in package.json

Several npm scripts are predefined for your convenience. You can run them using npm run <scriptname> | Script name | Description | |-------------|-------------| | test:js | Executes the tests you defined in *.test.js files. | | test:package | Ensures your package.json and io-package.json are valid. | | test:integration | Tests the adapter startup with an actual instance of ioBroker. | | test | Performs a minimal test run on package files and your tests. | | check | Performs a type-check on your code (without compiling anything). | | lint | Runs ESLint to check your code for formatting errors and potential bugs. | | translate | Translates texts in your adapter to all required languages, see @iobroker/adapter-dev for more details. | | release | Creates a new release, see @alcalzone/release-script for more details. |

Writing tests

When done right, testing code is invaluable, because it gives you the confidence to change your code while knowing exactly if and when something breaks. A good read on the topic of test-driven development is https://hackernoon.com/introduction-to-test-driven-development-tdd-61a13bc92d92. Although writing tests before the code might seem strange at first, but it has very clear upsides.

The template provides you with basic tests for the adapter startup and package files. It is recommended that you add your own tests into the mix.

Publishing the adapter

Using GitHub Actions, you can enable automatic releases on npm whenever you push a new git tag that matches the form v<major>.<minor>.<patch>. We strongly recommend that you do. The necessary steps are described in .github/workflows/test-and-release.yml.

Since you installed the release script, you can create a new release simply by calling:

npm run release

Additional command line options for the release script are explained in the release-script documentation.

To get your adapter released in ioBroker, please refer to the documentation of ioBroker.repositories.

Test the adapter manually on a local ioBroker installation

In order to install the adapter locally without publishing, the following steps are recommended:

  1. Create a tarball from your dev directory:
    npm pack
  2. Upload the resulting file to your ioBroker host
  3. Install it locally (The paths are different on Windows):
    cd /opt/iobroker
    npm i /path/to/tarball.tgz

For later updates, the above procedure is not necessary. Just do the following:

  1. Overwrite the changed files in the adapter directory (/opt/iobroker/node_modules/iobroker.unifi-protect-nvr)
  2. Execute iobroker upload unifi-protect-nvr on the ioBroker host

Changelog

1.1.1 (2024-10-18)

  • (Scrounger) translation optimized
  • (Scrounger) unifi-protect library updated to v4.15.0
  • (Scrounger) info is isThrottled added
  • (Scrounger) bug fixes

1.1.0 (2024-08-30)

  • (Scrounger) UP Sense integration

1.0.0 (2024-08-13)

  • (Scrounger) bug fixes
  • (Scrounger) dependencies updated

1.0.0-alpha.7 (2024-06-23)

  • (Scrounger) work in progress

1.0.0-alpha.6 (2024-06-22)

  • (Scrounger) work in progress

1.0.0-alpha.5 (2024-06-19)

  • (Scrounger) work in progress

1.0.0-alpha.4 (2024-06-17)

  • (Scrounger) work in progress

1.0.0-alpha.3 (2024-06-14)

  • (Scrounger) work in progress

1.0.0-alpha.2 (2024-06-11)

  • (Scrounger) bug fixes

1.0.0-alpha.1 (2024-06-09)

  • (Scrounger) testing fix

1.0.0-alpha.0 (2024-06-09)

  • (Scrounger) initial release

License

MIT License

Copyright (c) 2024 Scrounger [email protected]

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.