homebridge-star-projector

1.0.6 • Public • Published

homebridge-star-projector

npm npm GitHub last commit Donate

Creating and maintaining Homebridge plugins consume a lot of time and effort, if you would like to share your appreciation, feel free to "Star" or donate.

Click here to review more of my plugins.

Info

HomeKit Demo

This is a dynamic platform plugin for Homebridge to control Tuya / Smart Life based star projectors.

This Plugin creates a grouped Accessory (Switch, Lightbulbs and Fan) and it allows to customize the state, color, laser and star rotation of the star projector. You can also create scenes which expose Switches to HomeKit to enable your own configured scenes.

Tested Projectors

This plugin is verified to work with following Star Projectors:

https://www.amazon.de/dp/B08VGK1V82

Installation instructions

After Homebridge has been installed:

  • sudo npm i -g homebridge-star-projector@latest

Basic configuration

{
 "bridge": {
   ...
 },
 "accessories": [
   ...
 ],
 "platforms": [
   {
     "platform": "StarProjector",
     "name": "StarProjector",
     "debug": false,
     "projectors": [
         {
             "name": "Star Projector",
             "tuyaId": "asdsadsafasvasfsfs",
             "tuyaKey": "12w31231ascasdqasd"
         }
       }
     ]
   }
 ]
}

See Example Config for more details.

Credentials

In order to use the plugin, you need to find out your "Tuya ID / API Key" and your "Tuya Key / API Secret". Here is a great tutorial how you can generate your credentials.

Once you have your credentials, you just have to add it to your config.json, thats it.

Endpoints / DPS

This plugin uses the great TuyApi module. If you have problems switching the state, changing color, changing rotation etc., you can change the "endpoints" manually via config.json.

These "endpoints" are also called dps. The plugin uses the following (default) endpoints/dps:

  • 20 = Power State (true/false)
  • 21 = Mode ('white', 'colour', 'scene')
  • 22 = Laser Brightness (10 - 1000)
  • 24 = Color (HSB/V)
  • 25 = Scene
  • 26 = Countdown (Seconds) (currently not implemented)
  • 101 = Star Rotation Speed (10 - 1000)
  • 102 = Laser State (true/false)
  • 103 = Color State (true/false)

Supported clients

This plugin has been verified to work with the following apps on iOS 14:

  • iOS 14+
  • Apple Home
  • All 3rd party apps like Elgato Eve etc.
  • Homebridge v1.1.6+

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.

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 enable debug in your config and restart homebridge.

Disclaimer

All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.

Package Sidebar

Install

npm i homebridge-star-projector

Weekly Downloads

4

Version

1.0.6

License

MIT

Unpacked Size

56.6 kB

Total Files

11

Last publish

Collaborators

  • seydx