https://github.com/parnic/MMM-Unsplash

Show a random photo from an Unsplash collection
https://github.com/parnic/MMM-Unsplash

magicmirror magicmirror2 unsplash unsplash-api unsplash-collections

Last synced: 23 days ago
JSON representation

Show a random photo from an Unsplash collection

• Host: GitHub
• URL: https://github.com/parnic/MMM-Unsplash
• Owner: parnic
• License: mit
• Created: 2018-04-21T16:35:48.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-20T17:49:46.000Z (5 months ago)
• Last Synced: 2024-08-04T10:03:13.830Z (4 months ago)
• Topics: magicmirror, magicmirror2, unsplash, unsplash-api, unsplash-collections
• Language: JavaScript
• Size: 19.5 KB
• Stars: 8
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mmm - **MMM-Unsplash**

README

        
# MMM-Unsplash

A MagicMirror² module used to pull a random photo from one or more Unsplash collections. Like MMM-RandomPhoto, but for specific collections. Tested with MagicMirror² v2.2.2, v2.3.1 servers, Chrome 65 on Windows 10 and Midori 0.4.3 on a Raspberry Pi Zero W with Raspbian Jessie.

## Installation

1. Navigate into your MagicMirror's `modules` folder and execute `git clone https://github.com/parnic/MMM-Unsplash.git`.

2. Add the module inside `config.js` placing it where you prefer.

## Config

|Option|Type|Description|Default|

|---|---|---|---|

|`opacity`|double|The opacity of the image.|0.3|

|`collections`|string|(REQUIRED) Comma-delimited list of collections to pull from.|`''`|

|`width`|int|Desired image width.|`1080`|

|`height`|int|Desired image height.|`1920`|

|`orientation`|string|Orientation of the image. Valid values: `landscape`, `portrait`, `squarish`|`'portrait'`|

|`apiKey`|string|(REQUIRED) Your Unsplash API key.|`''`|

|`updateInterval`|int|Number of seconds between image updates. Note that your API key is rate-limited, so if, for example, your rate limit was 50/hr, this should be no less than 72.|`1800` (30mins)|

|`divName`|string|The ID of the div to use for the displayed image. This only needs to be set if you use something like [MMM-ProfileSwitcher](https://github.com/tosti007/MMM-ProfileSwitcher) and/or need to be able to load images from multiple Unsplash modules at once.|`'mmm-unsplash-placeholder'`|

Here is an example of an entry in config.js

```

{

	module: 'MMM-Unsplash',

	position: 'fullscreen_below',

	config: {

		collections: '369966,1240111,1136512,629911,150672,920773',

		apiKey: 'your_api_key'

	}

},

```

## Notes

Pull requests are very welcome! If you'd like to see any additional functionality, don't hesitate to let me know.

## Dependencies

None!

## Special Thanks

MMM-RandomPhoto for the inspiration. The core image update functionality is cribbed from this module.