All Projects → delightedCrow → WallberryTheme

delightedCrow / WallberryTheme

Licence: MIT license
Bringing the WallberryTheme to MagicMirror²

Programming Languages

javascript
184084 projects - #8 most used programming language
CSS
56736 projects
Nunjucks
165 projects

Projects that are alternatives of or similar to WallberryTheme

MMM-OpenmapWeather
This module loads current weather as images on Magic Mirror
Stars: ✭ 18 (-80.85%)
Mutual labels:  magicmirror, openweathermap, magicmirror2
MMM-forecast-io
Forecast.io Module for MagicMirror
Stars: ✭ 58 (-38.3%)
Mutual labels:  magicmirror, darksky, magicmirror2
MMM-network-signal
MagicMirror2 solid network status
Stars: ✭ 31 (-67.02%)
Mutual labels:  magicmirror, magicmirror2
epaper-clock-and-more
e-paper clock + weather + AQI + traffic delays - using Waveshare 2.7inch & 4.2inch eink displays running on Raspberry Pi
Stars: ✭ 34 (-63.83%)
Mutual labels:  openweathermap, darksky
MMM-mvgmunich
MagicMirror² Module to monitor public transport (U-bahn, tram, bus, S-Bahn) in Munich
Stars: ✭ 21 (-77.66%)
Mutual labels:  magicmirror, magicmirror2
MMM-EmbedYoutube
Embed youtube video for MagicMirror
Stars: ✭ 29 (-69.15%)
Mutual labels:  magicmirror, magicmirror2
MMM-MotionDetector
This is a motion detector module for MagicMirror
Stars: ✭ 32 (-65.96%)
Mutual labels:  magicmirror, magicmirror2
mmpm
MagicMirror Package Manager
Stars: ✭ 104 (+10.64%)
Mutual labels:  magicmirror, magicmirror2
MMM-Bring
A module for the MagicMirror that displays your Bring! shopping list.
Stars: ✭ 18 (-80.85%)
Mutual labels:  magicmirror, magicmirror2
MMM-MagicMover
MagicMirror² module to avoid screen burn-in
Stars: ✭ 21 (-77.66%)
Mutual labels:  magicmirror, magicmirror2
Myersplash.android
Yet anothor simple and elegant photos & wallpaper app for all platforms.
Stars: ✭ 84 (-10.64%)
Mutual labels:  unsplash
What The Splash
Tutorial for building an unsplash image gallery with redux saga :atom:
Stars: ✭ 107 (+13.83%)
Mutual labels:  unsplash
Myersplash.uwp
Yet anothor simple and elegant photos & wallpaper app for all platforms.
Stars: ✭ 207 (+120.21%)
Mutual labels:  unsplash
Androidunplash
An unofficial Unsplash API library for Android
Stars: ✭ 80 (-14.89%)
Mutual labels:  unsplash
Unsplash rb
💎 Ruby wrapper for the Unsplash API.
Stars: ✭ 202 (+114.89%)
Mutual labels:  unsplash
Unsplash Sketchplugin
Unsplash Data Provider plugin, for Sketch 52+
Stars: ✭ 71 (-24.47%)
Mutual labels:  unsplash
Unsplash
📸🔀☁️ Random Nextcloud log in background from Unsplash
Stars: ✭ 58 (-38.3%)
Mutual labels:  unsplash
React Native Camera Roll Tutorial
Mastering the Camera Roll in React Native
Stars: ✭ 42 (-55.32%)
Mutual labels:  unsplash
MMM-ShipmentTracking
Shipment Tracking Module for MagicMirror²
Stars: ✭ 24 (-74.47%)
Mutual labels:  magicmirror
addon-magicmirror
MagicMirror² - Home Assistant Community Add-ons
Stars: ✭ 40 (-57.45%)
Mutual labels:  magicmirror

WallberryTheme: A MagicMirror² Module

The WallberryTheme module re-themes MagicMirror² to look like a beautiful photo-box wall display. It adds a new font, styles, and periodically changing background image pulled from Unsplash.com.

The WallberryTheme also comes packaged with two companion modules for displaying the time (WB-clock) and weather (WB-weather).

REQUIRED API KEYS:

  • A (free) Unsplash API key is required and can be obtained from Unsplash.com.
  • For the weather module, a (free) OpenWeatherMap API key is required and can be obtained at OpenWeatherMap.org/api.

New and Shiny in 3.0.0

The WB-weather companion module has now been completely refactored with some great new features:

  • OpenWeatherMap is now the default weather provider (RIP DarkSky, you were taken too soon).
  • WB-weather still supports DarkSky as a provider for existing users with API keys, but expect the API to be shuttered officially by Apple by end of 2021.
  • New weather providers can be easily integrated by subclassing WB-weather's new WBProvider class.
  • New config option for choosing which display template to use, so you can easily change how the weather is displayed by adding new templates.

Go check out the details in WB-weather's README.

Screenshots

Now With More Options For Bright Images!

WallberryTheme has new options for dealing with light text on bright background images!

  • The addBackgroundFade option allows you to add soft gradient backgrounds to the top and bottom regions of your magic mirror, providing more contrast for the modules in those regions. These gradients use Unsplash's color data to automatically shift to the general color hue of the photo, so they blend better with the image.

  • The autoDimOn feature auto-detects bright images and automatically dims them, ensuring bright images don't wash out your text and dark images remain vibrant.

No background fade, auto dim set to off:

With addBackgroundFade and autoDimOn (on their default settings):

Using the module

To use this module and its companion modules:

  1. Copy the WallberryTheme folder to your MagicMirror/modules directory
  2. Add the modules to the modules array in the config/config.js file like in the following example:
modules: [
  // Base WallberryTheme adds new font, styles, and a rotating background image pulled from Unsplash.com
  {
    module: "WallberryTheme",
    position: "fullscreen_below", // Required Position
    config: {
      unsplashAccessKey: "Your Unsplash API Key", // REQUIRED
      collections: "2589108" // optional - leave empty for a random photo
    }
  },
  // WB-clock adds local time (Optional Module)
  {
    module: "WallberryTheme/WB-clock",
    position: "top_bar", // highly suggest using top_bar position
    config: {
      localCityName: "Seattle", // optional
      otherCities: [
      	{name: "DC", timezone: "US/Eastern"}, // optional
      	{name: "Anchorage", timezone: "US/Alaska"} // optional
      ]
    }
  },
  // WB-weather adds weather (Optional Module)
  {
    module: "WallberryTheme/WB-weather",
    position: "bottom_bar",  // Highly suggested location
    config: {
      // See "Configuration options" for more information.
      apiKey: "Your openweathermap API key", // REQUIRED
      latitude:   47.603230, // REQUIRED
      longitude: -122.330276 // REQUIRED
    }
  }
]

Configuration options

The following properties of WallberryTheme can be configured. For more information on how to configure the WB-clock and WB-weather modules see their individual README files.

Option Type Description
unsplashAccessKey String Your Unsplash API access key. Sign up for free at https://unsplash.com/developers. Demo accounts are allowed 50 API requests per hour.

This value is REQUIRED
collections String A comma-separated list of Unsplash collection IDs that photos should be pulled from. Collection IDs can be found in the URL of the collection, shown in the highlighted part of this screenshot:

Example: "1538150,162213"
Default value: "" (no collection, theme will use a random Unsplash photo)
queries Array A list of queries to search for on Unsplash. When multiple queries are specified, one gets randomly picked every refresh.

Example: ["cars", "new york", "black cat"]
Default value: []
updateInterval Number How often the photo should change (Milliseconds).

Default value: 300000 (5 minutes)
orientation String What screen orientation photos should be optimized for.

Possible values: "portrait", "landscape", or "squarish"
Default value: "portrait"
backgroundOpacity Number Controls the darkness of the background photo.

Possible values: Any number from 0.0 (black screen) to 1 (fully bright image)
E.G.: 0.5 would be the background at half brightness
Default value: 1
brightImageOpacity Number Controls the darkness of bright photos (determined by autoDimOn). Only used when autoDimOn is true.

Possible values: Any number from 0.0 (black screen) to 1 (fully bright image)
Default value: 0.85
autoDimOn Boolean Automatically darkens bright photos to the value set by brightImageOpacity.

Possible values: true (on) or false (off)
Default value: true
addBackgroundFade Array Adds darker gradient backgrounds to the top bar region and/or bottom bar regions of MagicMirror (helps with readability for bright or busy background images).

Possible values: "top" will add a gradient background to the top bar region, "bottom" will add a gradient background to the bottom bar region. Set to an empty list to remove all gradients.
Default value: ["top", "bottom"]
clearCacheOnStart Boolean Clears Electron's cache on MagicMirror startup, preventing an issue where Electron would sometimes encounter a CORS error when trying to load a previously cached background image (see this issue here for details).

Possible values: true (on) or false (off)
Default value: true
imageHeight String or Number Use "auto" to use your screen's height, or specify a hardcoded width in pixels.

Default value: "auto"
imageWidth String or Number Use "auto" to use your screen's width, or specify a hardcoded width in pixels.

Default value: "auto"
imageOptions String See Unsplash documentation for supported parameters.

Default value: "fit=crop"

Contributing

Contributions of all kinds (pull requests, bug reports, feature suggestions, documentation, etc) are all welcome and encouraged.

If you're enjoying the WallberryTheme and wanna make my day:

  • Buy me a coffee and fuel my motivation for open source development ;)
  • Post a screenshot of your MagicMirror running WallberryTheme in the GitHub discussion.

Huge thanks to everyone who has contributed and made the WallberryTheme better!

Guidelines for Pull Requests

  • Pull Requests should be submitted to the dev branch
  • If there isn't one already, it's helpful to open an issue detailing the feature/bug your PR will address before you submit it.
  • Add a short description of your change to the Changelog file file under the [Unreleased] section.

Attributions & Special Thanks

Changelog

Visit the Changelog file to see the latest changes to the project :)

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].