mirror of
https://github.com/sascha-hemi/hacs_waste_collection_schedule.git
synced 2026-03-21 04:06:03 +01:00
Adding my waste mobi (#1033)
* source for my_waste_mobi initial * be consistent with url/source/doc naming, add docs * some tidy * additional test case * additional failure case, looking at pulling all municipality info * renaming * update source doc * renamed to recyclecoach for simplicity and it's what they use publicly, updated extra_info and added tests * tidy up uneeded header sending
This commit is contained in:
54
doc/source/recyclecoach_com.md
Normal file
54
doc/source/recyclecoach_com.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Recycle Coach / recyclecoach.com
|
||||
|
||||
Support for schedules provided by [Recycle Coach](https://recyclecoach.com/),
|
||||
serving several regions and municipalities in the USA
|
||||
|
||||
## Configuration via configuration.yaml
|
||||
|
||||
```yaml
|
||||
waste_collection_schedule:
|
||||
sources:
|
||||
- name: recyclecoach_com
|
||||
args:
|
||||
street: 123 road way
|
||||
city: smithsville
|
||||
state: ohio
|
||||
```
|
||||
|
||||
### Configuration Variables
|
||||
|
||||
#### Basic Usage
|
||||
|
||||
**street**<br>
|
||||
*(string) (required)* Street address, `123 road way` skip punctuation if
|
||||
abbreviating road type
|
||||
|
||||
**city**<br>
|
||||
*(string) (required)* Name of your municipality
|
||||
|
||||
**state**<br>
|
||||
*(string) (required)* Name of state, two latter abbreviation of fully spelled
|
||||
out correctly
|
||||
|
||||
#### Alternative / Debugging Usage
|
||||
|
||||
If for some reason the above does not get what you want and you want to dig in,
|
||||
go ahead over to the [Recycle Coach Homepage][https://recyclecoach.com/) open
|
||||
up your browser developer tools on network, and watch as you search for your
|
||||
address.
|
||||
|
||||
The XHR response you're triggering should have a json blob where you can find
|
||||
your district_id and project_id. If you specify these, the script will skip the
|
||||
lookups and use those directly
|
||||
|
||||
**district_id**<br>
|
||||
*(string) (optional)* district_id provided by
|
||||
`https://recyclecoach.com/wp-json/rec/v1/cities` endpoint
|
||||
|
||||
**project_id**<br>
|
||||
*(numeric) (optional)* project_id provided by
|
||||
`https://recyclecoach.com/wp-json/rec/v1/cities` endpoint
|
||||
|
||||
**zone_id**<br>
|
||||
*(string) (optional)* string built from result set of
|
||||
`https://api-city.recyclecoach.com/zone-setup/address` endpoint
|
||||
Reference in New Issue
Block a user