Git Product home page Git Product logo

octoprint-octolexa's Introduction

OctoPrint-Octolexa

The Octolexa plugin for OctoPrint sends limited printer information to a database for access via Amazon Echo devices. The problem with other Alexa solutions is that they require exposing access to your Octoprint server over the public internet as well as require providing the external service with your Octoprint API key.

The Octolexa plugin eliminates that security risk by publishing only small informational status updates about your printer that can then be retrieved by the Octolexa Amazon Alexa Skill.

OctoPrint Setup

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

https://github.com/johnnyruz/OctoPrint-Octolexa/archive/master.zip

Octolexa Plugin Configuration

  1. Open the Settings tab of the OctoPrint-Octolexa Plugin
  2. Enter a desired name for your printer
  3. Click the Request Printer Registration button
  4. You will be redirected to the Octolexa Login Page. If you do not yet have an account, click "Sign-Up" and enter a valid email address and create a password. You will have to verify your email address and then you will be directed to a page that will provide a unique key for your printer.
  5. Enter that unique key in the box for Step 3 on the Octolexa Settings Page
  6. Click the Verify Registration
  7. After the info is verified, click Save

Alexa Setup

  1. Use the Alexa companion mobile app or website to enable the Octolexa Skill.
  2. Once enabled, click on Settings and select Link Account.
  3. Enter the Username and Password created in step 4 of the Plugin Configuration.
  4. You can now ask Alexa for your printer status by saying "Alexa, ask Octolexa for my printer status"

What Data is Stored in the Octolexa Database (Updated as of 7/29/2019)

  • Email address
  • Printer Name
  • Encrypted Printer Key Value
  • Printer Status (Offline, Operational, Printing, etc.)
  • Hot End Temperature
  • Bed Temperature
  • Current Job Completion Percentage
  • Current Job Z-height
  • Current Filename
  • Previous Job Duration
  • Previous Job Result (Completed, Cancelled, Failed, etc.)

Printers and their status are removed from the database if they have not checked-in within 10 days

octoprint-octolexa's People

Contributors

johnnyruz avatar

Stargazers

 avatar

Watchers

 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.