Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.7 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.7 KB
Raw

OctoLight

A simple plugin that adds a button to the navigation bar for toggleing a USB port on the Raspberry Pi. The program is hard coded to toggle port number 2, so please put the device you wish to control on this port.

WebUI interface

Setup

Install via the bundled Plugin Manager or manually using this URL:

https://github.com/gigibu5/OctoLight/archive/master.zip

Configuration

Settings panel

Curently, you can configure two settings:

  • Light PIN: The pin on the Raspberry Pi that the button controls.

    • Default value: 13
    • The pin number is saved in the board layout naming scheme (gray labels on the pinout image below).
    • !! IMPORTANT !! The Raspberry Pi can only control the GPIO pins (orange labels on the pinout image below) Raspberry Pi GPIO

  • Inverted output: If true, the output will be inverted

    • Usage: if you have a light, that is turned off when voltage is applied to the pin (wired in negative logic), you should turn on this option, so the light isn't on when you reboot your Raspberry Pi.

API

Base API URL : GET http://YOUR_OCTOPRINT_SERVER/api/plugin/octolight?action=ACTION_NAME

This API always returns updated light state in JSON: {state: true}

(if the action parameter not given, the action toggle will be used by default)

Actions

  • toggle (default action): Toggle light switch on/off.
  • turnOn: Turn on light.
  • turnOff: Turn off light.
  • getState: Get current light switch state.

TO DO

  • Update interface if Light is turned on or off

Maybe in the distant future:

  • Turn off on finish print