Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,16 @@ When a voice command is made to the Seizure Tracker Alexa skill, Amazon POSTs JS

Amazon determines a users intent using a custom JSON configuration defined for the skill by the skill developer. In this case, the JSON configuration for the intent model is defined per [configuration.json](configuration.json).

If a voice command request is valid and for one of the three primary functions of the skill, then the contents of a request is forwarded from [seizure.php](seizure.php) to the `handle_seizure` PHP function within [seizure.events.php](seizure.events.php).
If a voice command request is valid and for one of the four primary functions of the skill, then the contents of a request is forwarded from [seizure.php](seizure.php) to the `handle_seizure` PHP function within [seizure.events.php](seizure.events.php).

##### Primary functions

There are three primary functions within [seizure.events.php](seizure.events.php) (which is called by [seizure.php](seizure.php)) that interact with the SeizureTracker.com API to do the following things via Alexa voice commands:
There are four primary functions within [seizure.events.php](seizure.events.php) (which is called by [seizure.php](seizure.php)) that interact with the SeizureTracker.com API to do the following things via Alexa voice commands:

| Alexa Intent | PHP Function | Purpose |
| --------------- | ----------------- | --------------------------------------------------- |
| `CountSeizures` | `count_seizures` | Count seizures that have occurred today |
| `AddSeizure` | `add_seizure` | Track a new seizure |
| `AddVNS` | `add_vns` | Tie VNS stimulator usage/swipe to a seizure event |
| `EndSeizure` | `end_seizure` | Mark a (previously tracked) seizure as having ended |

---

### Future Plans?

#### Including these capabilities could be useful:
* Track whether seizure medication was taken
* Track vagal nerve stimulator (VNS) usage

#### "Flash Briefing" ideas:
* Medication reminder
* Announce count of seizures for the prior day
5 changes: 4 additions & 1 deletion TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,14 @@ ALL DONE :D

---


#### others

* IN PROGRESS: track VNS swipes/usage
* track whether medication was taken
* `class{}`-y PHP would be great...
* perhaps do some other stuff with Flash Briefing which announces count of seizures for the prior day...?
* somehow make `handle_seizure()` cooler instead of just treating whatever string it returns as success
* somehow make `handle_seizure()` cooler instead of just treating whatever string it returns as success
* maybe do more intense checking on phrases received from Alexa?
- it absolutely cannot do proper voice-to-text on the word *"ended"* no matter how I pronounce it!
* I've gotten back *"and 8"*, *"I ate and"*, and all kinds of crazy stuff that's not even close
Expand Down
Loading