Wondering what’s next for npm?Check out our public roadmap! »

homebridge-octoprint-motion

1.3.3 • Public • Published

homebridge-octoprint-motion

npm npm verified-by-homebridge

OctoPrint Plugin for Homebridge

This plugin exposes the current status of a 3D printer connected to OctoPrint as a Motion Sensor or Occupancy Sensor.

Installation

  1. Install Homebridge using the official instructions.
  2. Install this plugin using sudo npm install -g homebridge-octoprint-motion.
  3. Update your configuration file. See configuration sample below.

Configuration

Edit your config.json accordingly. Configuration sample:

"platforms"[
   {
       "platform": "octoprint",
       "instances": [
       {
           "name": "Monoprice",
           "manufacturer": "Monoprice",
           "model": "Maker Ultimate",
           "url": "http://monoprice.local",
           "api_key": "o03vc2y4tpj76iy814u1vklz0gidiqut",
           "case_light": true
       },
       {
           "name": "Big Boy",
           "manufacturer": "Creality",
           "model": "CR-10S S4",
           "url": "http://bigboy.local",
           "api_key": "oxunsmzv6hi9nkrcxnlbtg9azgsm2uaa"
       }
       ]
   }
]
Fields Description Required
platform Must always be octoprint. Yes
instances Array of Octoprint instance configs (multiple supported). Yes
|- name Name of your device. Yes
|- manufacturer Manufacturer of your device. No
|- model Model of your device. No
|- serial Serial of your device. No
|- url URL of your OctoPrint instance. Yes
|- api_key API Key for your OctoPrint instance. Yes
|- case_light Enables control of the printer's case light. No
|- occupancy_sensor Exposes an occupancy sensor instead of a motion sensor. No

Install

npm i homebridge-octoprint-motion

DownloadsWeekly Downloads

27

Version

1.3.3

License

BSD-2-Clause

Unpacked Size

38.1 kB

Total Files

8

Last publish

Collaborators

  • avatar