{"id":13593000,"url":"https://github.com/htilburgs/MMM-MyGarbage","last_synced_at":"2025-04-09T02:32:01.812Z","repository":{"id":42354059,"uuid":"172977945","full_name":"htilburgs/MMM-MyGarbage","owner":"htilburgs","description":"MagicMirror module for displaying Garbage pickup schedule","archived":false,"fork":false,"pushed_at":"2023-06-13T09:34:44.000Z","size":161,"stargazers_count":31,"open_issues_count":0,"forks_count":12,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-06T14:41:26.302Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/htilburgs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-02-27T19:38:26.000Z","updated_at":"2024-10-11T03:41:56.000Z","dependencies_parsed_at":"2024-01-14T04:39:30.581Z","dependency_job_id":"3e4a0e3f-97d8-41b5-a28a-e27c528d9a28","html_url":"https://github.com/htilburgs/MMM-MyGarbage","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/htilburgs%2FMMM-MyGarbage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/htilburgs%2FMMM-MyGarbage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/htilburgs%2FMMM-MyGarbage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/htilburgs%2FMMM-MyGarbage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/htilburgs","download_url":"https://codeload.github.com/htilburgs/MMM-MyGarbage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247965616,"owners_count":21025407,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T16:01:15.513Z","updated_at":"2025-04-09T02:31:59.330Z","avatar_url":"https://github.com/htilburgs.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Home Automation \u0026 Notifications"],"sub_categories":[],"readme":"# MMM-MyGarbage\nThis a module for [Magic Mirror²](https://github.com/MichMich/MagicMirror).\nThis displays the schedule for your Garbage pickup. It supports multiple types of garbage bins.\n\n![Screenshot](screenshot.png)\n\n## Installation\nClone this repository in your modules folder, and install dependencies:\n\n```\ncd ~/MagicMirror/modules \ngit clone https://github.com/htilburgs/MMM-MyGarbage.git\ncd MMM-MyGarbage\nnpm install \n```\n\n## Configuration\nGo to the MagicMirror/config directory and edit the config.js file.\nAdd the module to your modules array in your config.js.\n\n```\n{\n  module: 'MMM-MyGarbage',\n  position: 'top_left',\n  header: 'My Garbage Calendar',\n  config: {\n          alert: 4,\n          weeksToDisplay: 2,\n          limitTo: 99,\n          fade: true,\n          dateFormat: \"dddd D MMMM\",\n          fadePoint: 0.25\n  }\n},\n```\n\n## Module configuration\nHere is the documentation of options for the modules configuration:\n\n\u003ctable\u003e\n  \u003cthead\u003e\n    \u003ctr\u003e\n      \u003cth\u003eOption\u003c/th\u003e\n      \u003cth\u003eDescription\u003c/th\u003e\n    \u003c/tr\u003e\n  \u003c/thead\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003eweeksToDisplay\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eHow many weeks into the future to show collection dates.\u003cbr /\u003e\u003cbr /\u003e\u003cstrong\u003eNumber\u003c/strong\u003e\u003cbr /\u003eDefault: \u003ccode\u003e2\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003elimitTo\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eLimit the display to the spcified number of pickups.\u003cbr /\u003e\u003cbr /\u003e\u003cstrong\u003eNumber\u003c/strong\u003e\u003cbr /\u003eDefault: \u003ccode\u003e99\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003edateFormat\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eFormat to use for the date of events \u003cbr /\u003e\u003cbr /\u003e\u003cstrong\u003eDefault: \u003c/strong\u003e\u003ccode\u003edddd D MMMM\u003c/code\u003e (e.g. January 18)\u003cbr /\u003e\u003cstrong\u003ePossible values: \u003c/strong\u003eSee https://momentjs.com/\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003ealert\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003e(optional) Show alert, if remaining entries in csv file fall under this threshold\u003cbr /\u003e\u003cbr /\u003e\u003cstrong\u003eNumber\u003c/strong\u003e\u003cbr /\u003eDefault: \u003ccode\u003efalse\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003efade\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eFade the future events to black. (Gradient).\u003cbr /\u003e\u003cstrong\u003e\u003cbr /\u003eDefault: \u003c/strong\u003e\u003ccode\u003etrue\u003c/code\u003e\u003cbr /\u003e\u003cstrong\u003ePossible values: \u003c/strong\u003e\u003ccode\u003etrue\u003c/code\u003e or \u003ccode\u003efalse\u003c/code\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n        \u003ctr\u003e\n      \u003ctd\u003e\u003ccode\u003efadePoint\u003c/code\u003e\u003c/td\u003e\n      \u003ctd\u003eWhere to start fade?\u003cbr /\u003e\u003cstrong\u003e\u003cbr /\u003eDefault: \u003c/strong\u003e\u003ccode\u003e0.25\u003c/code\u003e\u003cbr /\u003e\u003cstrong\u003ePossible values: \u003c/strong\u003e\u003ccode\u003e0\u003c/code\u003e (top of the list) - \u003ccode\u003e1\u003c/code\u003e (bottom of list)\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n### Example config\n## Creating and using your Garbage Schedule\nYou can use this module by creating your own Garbage Schedule file with the name `garbage_schedule.csv` \nAn example file `garbage_schedule.csv` is added.\n\nCreate a CSV based on the following template:\n\n```\nWeekStarting,Greenbin,GarbageBin,PaperBin,PMDBin,OtherBin\n03/07/18,1,0,1,0,0\n03/14/18,1,1,1,0,0\n03/21/18,1,0,1,0,1\n03/28/18,1,1,1,1,0\n```\n\nDefault there are 3 bins defined (green, gray and blue) If you need more garbage bins, simply add an extra column in the `garbage_schedule.csv` file. The name is the color you like the bin to have. \n\nAdd lines for each garbage pickup date as needed.\nThe date format needs to be specified as `MM/DD/YY` (e.g.: 05/28/18 for 28-May-2018)\n\nPossible Values for colors:\n* Legacy Values:\n  * GreenBin (defaults to #00A651)\n  * GarbageBin (defaults to #787878)\n  * PaperBin (defaults to #0059ff)\n  * PMDBin (defaults to #ffff00)\n  * OtherBin (defaults to #B87333)\n* Any CSS color string (red, chocolate, cornflowerblue, etc..)\n* Any HEX-Color (#FF0000, #8c8c8c, etc)\n* Any rgb, rgba or hsl value **if in double quotes** (\"rgb(128,65,98)\", \"rgba(134,56,32,0.5)\", \"hsl(0, 100%, 50%)\", etc.)\n\nThe following is **VERY** important:\n* The CSV file must be delimited using commas\n* The date format needs to be specified as `MM/DD/YY` (e.g.: 05/28/18 for 28-May-2018)\n* The remaining fields of each line specify whether the particular waste product is scheduled to be picked up on the given date. A value of `0` means no pick up. A value of ANYTHING ELSE means the product will be picked up.  Using the first pick up date entry in the template above, `1,0,1` means that `green` and `blue` will be picked up on that date, while `gray` will not be picked up.\n\nSave the file as `garbage_schedule.csv` in the `MMM-MyGarbage` directory and restart Magic Mirror²\n\n## License\n### The MIT License (MIT)\n\nCopyright © 2019 Harm Tilburgs\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nThe software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.\n\n#### Note\nThe original script is from Jeff Clarke `MMM-MyWastePickup` and only for the Toronto area.\nNow it has become a general script, to use in all areas all over the world. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhtilburgs%2FMMM-MyGarbage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhtilburgs%2FMMM-MyGarbage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhtilburgs%2FMMM-MyGarbage/lists"}