Skip to content

MagicMirror-Module for viewing popular things on Thingiverse

License

Notifications You must be signed in to change notification settings

appdevelopmentandsuch/MMM-Thingiverse

Repository files navigation

MMM-Thingiverse

CodeFactor Maintenance GitHub license GitHub release GitHub tag Github all releases GitHub stars GitHub issues GitHub issues-closed

This is a module for the MagicMirror².

Display 3D printable objects found on Thingiverse Screenshot from 2021-02-20 07-37-07 Screenshot from 2021-02-20 07-37-33 Screenshot from 2021-02-20 07-38-44 Screenshot from 2021-02-20 07-40-01 Screenshot from 2021-02-20 07-40-07

Quickstart

cd ~/MagicMirror/modules
git clone https://github.com/appdevelopmentandsuch/MMM-Thingiverse

Using the module

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
  modules: [
    {
      module: "MMM-Thingiverse",
      position: "bottom_bar",
      config: {
        appToken: "",
      },
    },
  ],
};

Configuration options

Option Description
appToken Required A token aquired from the Thingiverse REST API to fetch things. You can aquire a token by going to https://www.thingiverse.com/apps/create and creating a Web App
updateInterval Optional The time in milliseconds before switching to the next thing.

Type: int(milliseconds)
Default 60000 milliseconds (1 minute)
retryDelay Optional The time in milliseconds before retrying the Thingiverse REST API due to a previous failure to get things.

Type: int(milliseconds)
Default 5000 milliseconds (5 seconds)
thingCount Optional The number of things you wish to grab and cycle through.

Type: int(count)
Default 100
startAtRandom Optional Start at a random position in the things.

Type: boolean(true/false)
Default false
numThingsDisplayed Optional Display 1, 3, or 5 things at any given time.

Type: int(1,3,5)
Default 1
category Optional Display things based on a provided category. A list of valid categories can be grabbed from the Thingiverse API using the endpoint https://api.thingiverse.com/categories?access_token=[YOUR_APP_TOKEN]. Use the slug entry for this prop

Type: string
Default