An open API service indexing awesome lists of open source software.

https://github.com/wilsonle/denison-laundry-status

API for checking status of washers and dryers of Denison University residential halls
https://github.com/wilsonle/denison-laundry-status

Last synced: about 1 month ago
JSON representation

API for checking status of washers and dryers of Denison University residential halls

Awesome Lists containing this project

README

          

# Denison Laundry Status API

## Dev Note:

~~project is under maintenance, please try again when this line is removed. I am kinda busy with college lately xD~~

It turns out the API host expires my auth token. All I need to do is setup the interceptor to extract the auth token and update project secrets. Now it should work normally.

## Table of Content:

- [Endpoint URI](#endpoint)
- [Sample request body](#sample-request-body)
- [Sample response body](#sample-response-body)
- [Technologies](#technologies)

## Endpoint

- POST http://us.wilsonle.me:7345

## Sample Request Body

```
{
"room": "Curtis Hall"
}
```

Possible hall names:

- Schaffer House
- Beaver Hall
- Beta House
- Chamberlin House
- Crawford Hall
- Curtis Hall
- East Hall
- Lower Elm
- Upper Elm
- Gilpatrick House
- Hayes Appartment
- Huffman Hall
- Kappa Sigma
- King Hall
- Morrow House
- Moshier-Huchison House
- Preston House
- Sawyer Hall
- Shaw Hall
- Shepardson Hall
- Silverstein Apartments - 2nd
- Silverstein Apartments - 4th
- Smith Hall
- Stone Hall
- Pratt Hall
- Brown Hall
- Myers Hall
- Good Hall
- Sunset House
- Taylor House
- Wright Apartments

## Sample Response Body

```
{
"machineStatus": {
"dryers": [
{
"type": "dryer",
"remainingSeconds": 3300,
"status": "READY TO START"
},
{
"type": "dryer",
"remainingSeconds": 3300,
"status": "READY TO START"
},
{
"type": "dryer",
"remainingSeconds": 3300,
"status": "AVAILABLE"
},
{
"type": "dryer",
"remainingSeconds": 3600,
"status": "AVAILABLE"
}
],
"washers": [
{
"type": "washer",
"remainingSeconds": 1800,
"status": "READY TO START"
},
{
"type": "washer",
"remainingSeconds": 1800,
"status": "READY TO START"
},
{
"type": "washer",
"remainingSeconds": 1800,
"status": "READY TO START"
},
{
"type": "washer",
"remainingSeconds": 1800,
"status": "AVAILABLE"
},
{
"type": "washer",
"remainingSeconds": 1800,
"status": "AVAILABLE"
}
],
"availableDryers": 4,
"completeDryers": 0,
"inUsedDryers": 0,
"errorDryers": 0,
"availableWasher": 5,
"completeWashers": 0,
"inUsedWashers": 0,
"errorWashers": 0,
"messages": "Right now, there are 5 available washer, and 4 available dryers"
}
}
```

## Siri Shortcut

- Link to the Siri shortcut that calls this API:
- https://www.icloud.com/shortcuts/44d1ee9e73de4da4b275ca87ba9558f2
- This will allow you to ask Siri to speak the "messages" key of the response body whenever you say "laundry status"
- You can customize the summon command (default by "laundry status") to whatever you like by editing the shortcut yourself.
- You can edit the hall you want to know the status of (usually the hall you are living in). By default it's Curtis Hall because I live there 😁

![How to change the hall you want to get status of](https://i.ibb.co/qjFW3z5/IMG-3133.jpg)

## Technologies

- [Docker](https://www.docker.com)
- [NodeJS](https://nodejs.org/en/)