Coder Social home page Coder Social logo

rtuszik / homebridge-vzug Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 207 KB

Homebridge Plugin for V-Zug Appliances

Home Page: https://www.npmjs.com/package/homebridge-vzug

License: Apache License 2.0

TypeScript 100.00%
homebridge homebridge-plugin homebridge-plugins homekit-accessory v-zug vzug

homebridge-vzug's Introduction

Homebridge V-ZUG Plugin

Integrate your V-ZUG appliances into Apple HomeKit using this Homebridge plugin, which currently supports status monitoring via an unofficial REST API. This plugin provides a HomeKit switch to reflect the operational status of your V-ZUG appliance, allowing you to check if the device is active.

Features

  • Status Monitoring: Exposes the operational status of your V-ZUG appliances as a switch in HomeKit, showing if the device is active.

Installation

  1. Install Homebridge:
    npm install -g homebridge
  2. Install the V-ZUG Plugin:
    npm install -g homebridge-vzug

Configuration

Add your V-ZUG appliances to your Homebridge config.json:

{
  "platform": "homebridge-vzug",
  "devices": [
    {
      "name": "DEVICE_NAME",
      "ip": "DEVICE_IP_ADDRESS"
    }
  ]
}

Example Configuration

{
  "platform": "homebridge-vzug",
  "devices": [
    {
      "name": "Oven",
      "ip": "192.168.1.10"
    },
    {
      "name": "Chef's Secret",
      "ip": "192.168.1.11"
    }
  ]
}

Supported Models

  • Currently tested with:
    • V-Zug CombairSteamer V6000 60Y
    • V-Zug CombairSteamer V6000 45F

The plugin will automatically find the Model and Serial Number of your Device and populate the relevant fields for HomeKit

Developer's Note

This is my first Homebridge plugin, primarily aimed at status monitoring for V-ZUG appliances. It's pretty basic โ€“ mainly showing the on/off status. Since it's my initial release, there might be some room for improvement. I'm open to feedback and suggestions!

Regarding future updates, I plan to enhance the plugin as time allows, potentially adding new features based on the community's input and any additional API information I come across. Your thoughts and contributions are always welcome!

Contributions and Support

  • Your contributions and feedback are welcome! Please consider contributing if you have access to more API info or different V-ZUG devices.
  • Report issues or suggest enhancements on the GitHub issues page.

Additional Resources

homebridge-vzug's People

Contributors

rtuszik avatar

Watchers

 avatar

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.