Git Product home page Git Product logo

homebridge-octoprint's Introduction

homebridge-octoprint

Plugin to support OctoPrint 3D printer control via the HomeBridge Platform.

Installation

  1. Install homebridge using: npm install -g homebridge
  2. Install homebridge-octoprint using: npm install -g homebridge-octoprint
  3. Update your configuration file. See sample-config.json in this repository for a sample or below.
"accessories": [
    {
      "accessory": "OctoPrint",
      "name": "OctoPrint",
      "api_key": "XXXXX"
    }
]

What does this plugin do?

This plugin adds the current print status of OctoPrint to HomeKit. The print status is shown as a lightbulb, with the brightness value equaling the current print progress (0-100%). If you deactivate the lightbulb, octoprint is instructed to abort the current print. Note, that print jobs cannot be started with this plugin (so activating the lightbulb does not do anything).

Notes for implementation

Possible Characteristics and Services

Description of characteristics (available methods and how to build listener) can be found here. Characteristics hava a setValue() and a getValue() method.

Overview of all available characteristics and services can be found here.

When adding characteristics:

  • getCharacteristic: Searches for characteristic in service and returns it. If non existent but optional -> create one and return it
  • setCharacteristic: getCharacteristic + setValue()

Start in Developer Mode

To start the plugin in developer mode run homebridge -D -P . -U ~/.homebridge-dev/ while beeing in the root directory. A sample config has to be saved at ~/.homebridge-dev/.

homebridge-octoprint's People

Contributors

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