# OctoPrint-PbPiLink

**Repository Path**: RenShen/OctoPrint-PbPiLink

## Basic Information

- **Project Name**: OctoPrint-PbPiLink
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2016-03-06
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Printrboard Pi Link Plugin

---

**PRERELEASE:** Provided "as is" for now. If you do not have a Printrboard Pi Link board, this plugin is useless for you.

---

Addon plugin for the [Printrboard Pi Link board](https://github.com/j-laird/Printrboard-Pi-Link).

Will add a toggle button for the Printrboard 12V power supply to the navigation bar and also include the
Raspberry Pi serial port in the "Additional Ports" section of usable serial ports if it's not already
included.

## Setup

Install via the bundled [Plugin Manager](https://github.com/foosel/OctoPrint/wiki/Plugin:-Plugin-Manager)
or manually using this URL:

    https://github.com/foosel/OctoPrint-PbPiLink/archive/master.zip

You also need [WiringPi](https://projects.drogon.net/raspberry-pi/wiringpi/download-and-install/)
set up, otherwise OctoPrint won't be able to manipulate the power switching GPIO pin.

Please refer to the [README of the Printrboard Pi Link repository](https://github.com/j-laird/Printrboard-Pi-Link#printrboard-pi-link).

## Configuration

``` yaml
plugins:
  pbpilink:
    # whether to power on the Printrboard on startup
    # of OctoPrint
    power_on_startup: true

    # whether to power off the Printrboard on shutdown
    # of OctoPrint
    power_off_shutdown: true

    # whether to power on the Printrboard when a client connects
    # to the web interface
    power_on_clients: false

    # whether to power off the Printrboard when no clients are
    # connected and no print is ongoing
    power_off_noclients: false

    # after how many seconds without any connected
    # clients to power off the Printrboard
    noclients_countdown: 60

    # whether to power on the Printrboard before serial connect
    power_on_connect: true

    # whether to power off the Printrboard on serial disconnect
    power_off_disconnect
```

## Future Improvements

  * Serial port wrapper with custom "PbPiLink" name and auto connect
  * tbc