Coder Social home page Coder Social logo

iobroker-community-adapters / iobroker.elgato-key-light Goto Github PK

View Code? Open in Web Editor NEW

This project forked from xxbjxx/iobroker.elgato-key-light

1.0 0.0 1.0 9.53 MB

With the Elgato Key Light Adapter you can query and control Elgato lamps like Elgato Key Light / Elgato Key Light Air.

License: MIT License

JavaScript 4.32% TypeScript 94.32% CSS 0.80% HTML 0.56%
elgato elgato-key-light iobroker iobroker-adapter

iobroker.elgato-key-light's Introduction

Logo

ioBroker.elgato-key-light

NPM version Downloads Number of Installations Current version in stable repository

Tests: Test and Release

elgato-key-light adapter for ioBroker

DISCLAIMER

All product and company names or logos are Trademarks™ or Registered® Trademarks of their respective owners. Their use does not imply any Affiliation or endorsement by them or associated affiliates! This personal project is being pursued on a recreational basis and Has no business objectives. Elgato is a trademark of Corsair GmbH.

Sentry

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers.
For more details and for information on how to disable error reporting, see. Sentry Plugin Documentation! Sentry reports are used starting with js-controller 3.0 are used.

Credits

This adapter would not have been possible without the great work of @xXBJXx (https://github.com/xXBJXx), who created this adapter and will hopefully maintain it again in the future.

Description

This adapter allows you to control Elgato Key Lights via ioBroker.
The adapter supports the following functions:

Adapter UI

A classic adapter UI under instances does not exist.
Adapter UI Adapter UI

What can be done in the UI?

  • No. 1 set the polling interval for the adapter (default: 60 seconds). after changing the interval, the adapter must be restarted, this is done using the Save button.
  • No. 2 add a new device to the adapter.
  • No. 3 set the color temperature for all key lights (2900K to 7000K)
  • No. 4 set the brightness for all Key Lights (0% to 100%)
  • No. 5 set the color for from the Light Strips
    Adapter UI
  • No. 6 switch the lights on and off

when changing No. 3, No. 4 and No. 5, the change will be executed after 1.5 seconds.

Warning

Please do not access the data points too often, otherwise the devices will not be accessible for a few seconds.

Data points

The data points are created automatically when a new device is found.

Data points for all Key Lights / Light Strips

Adapter UI
The data points are divided into:

  • info ⇨ Information about the device. Adapter UI
  • light ⇨ Data points for controlling the device, here there are two different types of data points:
    • for controlling brightness and color temperature. Adapter UI
    • for controlling the color Adapter UI
  • settings ⇨ data points for info from the settings of the device Adapter UI

Notes

  • The data points for color are only available for the Light Strips.
  • The data points for color temperature are only available for the Key Lights.
  • The data points for brightness are available for all Key Lights and Light Strips.
  • The scenes from the Light Strips are not supported. Since they are not accessible via the API.

Changelog

1.1.0 (2024-04-14)

  • (mcm1957) Adapter requires node.js 18 and js-controller >= 5 now
  • (mcm1957) Dependencies have been updated

1.0.1 (2024-01-18)

  • (mcm1957) Writing states now requires ack flag to be false.
  • (mcm1957) Small adaptions to solve review issues have been applied.

1.0.0 (2024-01-18)

  • (mcm1957) Adapter requires node.js 18 or newer now
  • (mcm1957) Adapter has been moved into iobroker-community-adapters area
  • (mcm1957) Dependencies have been updated

0.2.0 (2023-02-26)

  • (xXBJXx) updated dependencies
  • (xXBJXx) Updating the UI to the new functions of the iobroker-react library

0.1.0 (2023-02-06)

  • (xXBJXx) removed the Bonjour search, because it did not work properly
  • (xXBJXx) Adding a delete function for devices
  • (xXBJXx) Dependency updates
  • (xXBJXx) feature request #2 added

License

MIT License

Copyright (c) 2024 iobroker-community-adapters [email protected] Copyright (c) 2023 xXBJXx [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.

iobroker.elgato-key-light's People

Contributors

dependabot[bot] avatar mcm1957 avatar xxbjxx avatar

Stargazers

 avatar

iobroker.elgato-key-light's Issues

Update stable version in repo from 0.0.0 to 1.0.1

Think about adding version 1.0.1 to stable repository.

Version: stable=0.0.0 (0 days old) => latest=1.0.1 (30 days old)
Installs: stable=0 (0%), latest=8 (42.11%), total=19

Click to use developer portal
Click to edit

Note: This is an automatically generated message and not personally authored by bluefox!
Do not close this issue manually as a new issue will be created if condition for update still exists
@mcm1957 for evidence

Finalize migration of adapter

  • migrate or fork/importgithub repository to iobroker-community adapters
  • add access for ex-owner (if desired)
  • add a issue at old repository stating the move (if forked/imported only)
  • check access to npm
  • add npm owner bluefox
  • add npm owner apollon77
  • adapt links at package.json
  • adapt owner at package.json
  • adapt links at io-package.json
  • adapt owner at io-package.json
  • add github testing and release
  • update testing to node 18/20
  • add dependabot
  • add changelog at README.md
  • add credits at README.md
  • adapt latest repository links - PR exists
  • adapt stable repository links - n/a not listed at stable
  • add package to community at npm
    .
  • run adapter checker and fix issues
    .
  • create a new release
    .
  • check wether an maintainer is available

Update stable version in repo from 1.0.1 to 1.1.0

Think about update stable version to 1.1.0

Version: stable=1.0.1 (102 days old) => latest=1.1.0 (15 days old)
Installs: stable=19 (76%), latest=4 (16%), total=25

Click to use developer portal
Click to edit

Do not close this issue manually as a new issue will be created if condition for update still exists.

Please drop a comment if any reason exists which blocks updating to version 1.1.0 at this time.

Note: This is an automatically generated message and not personally authored by bluefox!
@mcm1957 for evidence

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.