https://github.com/blixhavn/mmm-avfallshentingoslo
MagicMirror² module for showing next pickup dates for different types of trash for Oslo.
https://github.com/blixhavn/mmm-avfallshentingoslo
Last synced: 3 months ago
JSON representation
MagicMirror² module for showing next pickup dates for different types of trash for Oslo.
- Host: GitHub
- URL: https://github.com/blixhavn/mmm-avfallshentingoslo
- Owner: blixhavn
- License: mit
- Created: 2020-11-18T13:39:56.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-26T18:19:59.000Z (over 4 years ago)
- Last Synced: 2025-02-13T21:17:41.678Z (4 months ago)
- Language: JavaScript
- Size: 48.8 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MMM-AvfallshentingOslo
This is a module for [MagicMirror²](https://magicmirror.builders/) to show the next waste pickup dates for any address in Oslo, Norway. It gets the dates by scraping the [municipal lookup service](https://www.oslo.kommune.no/avfall-og-gjenvinning/avfallshenting/). All of the information on the board can be configured, ensuring you can get the exact look you want.
## Installation
Enter your MagicMirror² module folder, e.g.:
cd ~/MagicMirror/modules
Clone the repository
git clone https://github.com/blixhavn/MMM-AvfallshentingOslo.git
Install the dependencies
cd MMM-AvfallshentingOslo
npm install
Add the module to your configuration file, for instance:
{
module: "MMM-AvfallshentingOslo",
position: "top_right",
config: {
address: "Maridalsveien 52",
dateFormat: "dddd Do MMM",
useHumanFormat: "by_week",
showHeader: false,
updateSpeed: 1000,
refresh: 3600,
displayIcons: true,
displayWasteType: false,
exclusions: ["Restavfall", "Restavfall til forbrenning"],
}
},
## Configuration options
| Configuration option | Comment | Default |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| address | Street address to provide to the lookup service. Typically your home address. | "Slottsplassen 1" |
| dateFormat | String specifying the date format for the Moment.js library. [See documentation here](https://momentjscom.readthedocs.io/en/latest/moment/04-displaying/01-format/). | "dddd Do MMMM" |
| useHumanFormat | Accepts options "strict", "by_week". As the "Next thursday" phrase can be interpreted differently, I've included two options. `strict` means that any date within a week (7 days) will display the weekday, while dates between one and two weeks away will display "Next {weekday}". `by_week` will display "Next {weekday}" if the date is within the date range for next week (e.g. on friday it will display "Next monday" for the upcoming monday). Omitting the config, or setting it to anything but these options will always display the above dateFormat.|"by_week" |
| showHeader | Boolean for whether or not to display header for the module (see example in image above) | false |
| updateSpeed | Transition speed when updating the display (in milliseconds). | 1000 |
| refresh | Refresh interval for polling the website for new information (in seconds). | 3600 |
| displayIcons | Boolean for whether or not to display waste icons. Uses the [official waste icons](https://sortere.no/avfallssymboler) for Norway. | true |
| displayWasteType | Boolean for whether or not to display waste type text. | false |
| exclusions | List for waste types to exclude from the list. Needs to match the exact text, but is case insensitive. | [] |
## Feedback and contributions
If you have any feedback, questions or suggestions, do not hesitate to make an issue on GitHub 🙂 Also, feel free to make contributions in form of pull requests!
## License
MMM-AvfallshentingOslo is released under the MIT license. Have at it.
-----
Made by Øystein Blixhavn