Skip to content

OctoPrint / Octopi plugin to control relays

Notifications You must be signed in to change notification settings

ahmetdereli/OctoRelay

 
 

Repository files navigation

OctoRelay

A plugin that adds buttons to the navigation bar to toggle GPIO pins on the Raspberry Pi.

This Plugin was based on the Octolight Plugin by Žiga Kralj (https://github.com/gigibu5/OctoLight) thanks ;-)

WebUI interface

I use it with a 4 relay board, and printed this case for it: https://www.thingiverse.com/thing:2975944

Relay Board

just hooked up the GPIO pins with the relay board, and now I can turn the power of the printer, the fan and the light on and foo with OctoPrint.

Raspberry Pi GPIO

Setup

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

https://github.com/borisbu/OctoRelay/archive/master.zip

Configuration

Settings panel

Curently, OctoRelay supports up to 8 relays:

key value
Relay X active if true, this relay is active. If false, it will disappear in the settings and the navigation bar
GPIO Number the GPIO pin on the Raspberry pi (see the picture above)
On on boot if ticked this pin will be set to ON on start
Inverted output if ticked the output on the pin is inverted (ex. relays is ON if GPIO pi is GND and OFF if GPIO pin is 3.3V)
Icon On piece of html output if the relay is ON (can be text, img...)
Icon Off piece of html output if the relay is OFF
Label the html title of the icon in the navbar (text if you hover the icon)
Confirm if ticked, a confirmation dialog shows before turning the relay off
Auto ON/OFF
Auto ON before printing Turn the relay automatically ON if a print starts
Auto OFF after print finishes Turn the relay OFF after a print finishes
Auto OFF delay Wait for X seconds before turning OFF the relay automatically. For exampe for a fan that should run a bit longer

Versions/Features/Bugfixes

1.0.0

  • turn relays on and off
  • change icon
  • power on on boot

1.1.0

  • optional confirm dialog on turning OFF
  • Auto ON/OFF on start and finish of the print job
  • Auto OFF delay for a fan, that should run longer after the print finished

1.1.1

  • Add api command to get pin status {'pin': 'r1', 'command': 'getStatus'}
  • Poll GPIO to update the UI if the state changes in the backround

1.2.0

  • Add api command to get all the states at once

About

OctoPrint / Octopi plugin to control relays

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 67.0%
  • Jinja 26.3%
  • JavaScript 5.1%
  • Shell 1.6%