From d5a32c283305c0cdec55d3f731480bef9e30e18f Mon Sep 17 00:00:00 2001 From: William Floyd Date: Tue, 19 Jun 2018 18:42:46 -0400 Subject: [PATCH] rice: API plan docs are starting. --- content/_index.md | 8 ------ content/page/about.md | 8 +++--- content/post/smart-rice-cooker-part-1.md | 31 ++++++++++++++++++++++-- 3 files changed, 33 insertions(+), 14 deletions(-) delete mode 100644 content/_index.md diff --git a/content/_index.md b/content/_index.md deleted file mode 100644 index 4282edf..0000000 --- a/content/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -author: "William Floyd" -date: 2018-06-18 -title: Blog -weight: 10 ---- - -Foobar Index diff --git a/content/page/about.md b/content/page/about.md index dc87510..fc7676f 100644 --- a/content/page/about.md +++ b/content/page/about.md @@ -1,6 +1,6 @@ -+++ -title = "About" -date = "2018-06-18" -+++ +--- +title: "About" +date: "2018-06-19" +--- I am William Floyd, this is my blog. diff --git a/content/post/smart-rice-cooker-part-1.md b/content/post/smart-rice-cooker-part-1.md index 00968ea..8b9362b 100644 --- a/content/post/smart-rice-cooker-part-1.md +++ b/content/post/smart-rice-cooker-part-1.md @@ -1,7 +1,7 @@ --- +title: "Smart Rice Cooker Conversion: Part 1" +date: "2018-06-18" author: "William Floyd" -date: 2018-06-18 -title: Smart Rice Cooker Conversion - Part 1 --- The "why" isn't important (read "doesn't exist"), but I want to take a regular old "dumb" rice cooker, and convert it into a "smart" rice cooker. @@ -23,3 +23,30 @@ Ideally, I will have the rice cooker serve an API, which my Orange Pi will bounc For now though, I am away from home, working, so I can't do anything on this for at least another 2 weeks, probably 3. Many of my parts have arrived (rice cooker, thermistors, relay, and NodeMCU), so once I get home, I can hit the ground running. + +#### API + +I tentatively (with no real experience designing them) plan on my API being the following. + +*Italicized* = Description +**Bolded** = Final endpoints + +- /sensor + - /temperature + - *Returns temperature* +- /action + - *Contains all physical heating/cooling/moving actions* + - /temperature + - *Contains all temperature related actions* + - **/kill** + - *Stops all cooking, lets the cooker cool to room temperature* + - **/change** + - *Heat/cool to given temperature, then hold* + - *Should allow setting a target heat/cool rate* + - *Should allow setting a hold duration* +- /routine + - /cook + - **/list** + - *List known cooking routines* + - **/start** + - *Start, or optionally schedule a routine*