Skip to content
Magic Mirror Module to display bin collection details from West Berkshire Council's API
JavaScript CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Initial commit Jul 2, 2019
LICENSE
MMM-WestBerksBinDay.css
MMM-WestBerksBinDay.js
README.md
binday_icons.svg
node_helper.js
package-lock.json
package.json Sort collections by date, nearest first Jul 4, 2019
screenshot.png

README.md

MMM-WestBerksBinDay

Magic Mirror Module to display bin collection details from West Berkshire Council's API

Screenshot

Installation

Clone this repository in your modules folder, and install dependencies:

cd ~/MagicMirror/modules 
git clone https://github.com/hdurdle/MMM-WestBerksBinDay.git
cd MMM-WestBerksBinDay
npm install 

Configuration

Go to the MagicMirror/config directory and edit the config.js file. Add the module to your modules array in your config.js.

You'll need your uprn (Unique Property Reference Number) from the West Berks Council website. You can find this by searching for your address here: http://ww2.westberks.gov.uk/internetmapping/AddressFinder_v2.aspx

You'll get a 12 digit number. Enter this in the config.js for your MagicMirror installation:

    {
        module: 'MMM-WestBerksBinDay',
        position: 'top_left',
        header: 'Bin Day',
        config: {
            uprn: "123456789012",
            dateFormat: "dddd D MMMM"
        }
    },

Module configuration

The module only has two possible configuration options:

Option Description
uprn Unique Property Reference Number for your house.

Default: undefined
dateFormat Format to use for the date of events

Default: dddd D MMMM (e.g. January 18)
Possible values: See https://momentjs.com/

Notes

The module is currently hard-coded to pull only the Grey and Green (recycling) bin details from the API. The API does contain other details - bulky waste, container maintenance etc - but those are not as useful on a week to week basis.

Thanks

Hat tip to Harm Tilburgs and his MMM-MyGarbage module, which inspired this code, and provided the nice SVG icons.

You can’t perform that action at this time.