Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update virtual assistants v2 #5137

Merged
merged 66 commits into from
Dec 6, 2019
Merged
Show file tree
Hide file tree
Changes from 65 commits
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
d767102
Merge pull request #1 from nightscout/master
inventor96 Jul 30, 2019
202402f
Copied work done by mdomox
inventor96 Sep 6, 2019
e36a6f1
Updates and fixes to CONTRIBUTING.md
inventor96 Sep 6, 2019
93f8eb9
Spacing unification
inventor96 Sep 7, 2019
3b183a2
One more fix for CONTRIBUTING.md
inventor96 Sep 7, 2019
a7bf320
Minor code formatting improvements
inventor96 Sep 7, 2019
ce00c94
One more time...
inventor96 Sep 7, 2019
efa35c4
Renamed Alexa stuff to virtAsst for generic-ness
inventor96 Sep 7, 2019
51c8d2c
Corrected missed translate() text
inventor96 Sep 8, 2019
58162c2
Updated googlehome plugin to mimic the alexa plugin
inventor96 Sep 8, 2019
b39eb8f
Changed order of operations
inventor96 Sep 8, 2019
8a20015
Fixed parameter referencing in googlehome
inventor96 Sep 8, 2019
90562a3
Yet another CONTRIBUTING fix
inventor96 Sep 8, 2019
855b64d
Removed extra google stuff
inventor96 Sep 8, 2019
2238067
Migrated standalone intents to MetricNow intent
inventor96 Sep 8, 2019
b3a47b3
Simplified route handling
inventor96 Sep 8, 2019
79f0217
Added logging
inventor96 Sep 8, 2019
cc56ef8
Added forgotten path selector
inventor96 Sep 8, 2019
0b1ce34
Separated instructions for adding virtual assistant support in a plugin
inventor96 Sep 8, 2019
0d85439
A few typo fixes
inventor96 Sep 8, 2019
f74d6a8
Improved logging
inventor96 Sep 8, 2019
c266cab
Updated Google Home plugin instructions
inventor96 Sep 9, 2019
895407d
Attempt to trigger download of template file
inventor96 Sep 9, 2019
478b25b
Small wording tweaks
inventor96 Sep 9, 2019
c562e7d
Updated Alexa plugin documentation
inventor96 Sep 10, 2019
3563158
Updated test files
inventor96 Sep 10, 2019
0a48c1d
Re-added handler count tests so devs are prompted to write tests for …
inventor96 Sep 10, 2019
658ca16
Updated Alexa documentation
inventor96 Sep 10, 2019
2b3d783
Small typo fix
inventor96 Sep 10, 2019
73d4e04
Clarification
inventor96 Sep 10, 2019
f946f4f
Further clarifications and typos
inventor96 Sep 10, 2019
6ff8aa3
Added language info to Google Home plugin doc
inventor96 Sep 12, 2019
92d2f70
URL correction
inventor96 Sep 12, 2019
41c0335
URL fix v2
inventor96 Sep 12, 2019
f188f4f
Wording clarification
inventor96 Sep 12, 2019
071d980
Ugh...
inventor96 Sep 12, 2019
313bb60
Minor instruction fix
inventor96 Sep 12, 2019
67ae84d
Sub steps fix
inventor96 Sep 12, 2019
dd6e691
Fixed Alexa references in Google Home
inventor96 Sep 12, 2019
6032aab
Added a couple steps for improved user experience
inventor96 Sep 12, 2019
87261af
One more forgotten step
inventor96 Sep 12, 2019
450fbc2
Updated pump reservoir handler to handle undefined values
inventor96 Sep 16, 2019
bf57dfe
Updated titles and unknown-value responses
inventor96 Sep 16, 2019
ddd8f63
Modified forecast responses to use translate()
inventor96 Sep 16, 2019
d3346fe
Updated tests
inventor96 Sep 16, 2019
6dee062
Improved training phrases
inventor96 Sep 16, 2019
61884f2
Wording improvements
inventor96 Oct 16, 2019
0fc121c
Google Home setup instruction corrections
inventor96 Oct 19, 2019
3cb3f47
Corrected how metric selection is found
inventor96 Oct 20, 2019
7770ff9
Improved logic to handle Alexa intents
inventor96 Oct 21, 2019
8b1bbb5
Clarification
inventor96 Oct 21, 2019
376a712
Logic correction
inventor96 Oct 21, 2019
67e6cdd
Merge branch 'update-virtual-assistants' into update-virtual-assistan…
inventor96 Oct 21, 2019
bda8793
Updated Alexa template to comply with new requirements
inventor96 Oct 22, 2019
85b8a9e
Merge branch 'update-virtual-assistants-fix-alexa-rollup' into update…
inventor96 Oct 22, 2019
13dd0fa
Fixed a few missing definitions
inventor96 Nov 1, 2019
c6e2b58
Translation improvements
inventor96 Nov 5, 2019
98b222c
Defined `translate()` in upbat plugin
inventor96 Nov 5, 2019
b9dc376
Migrated titles to use translate()
inventor96 Nov 5, 2019
c33aebb
Migrated static intent titles to use translate()
inventor96 Nov 5, 2019
43a32b3
Misc fixes for tests (even though they didn't fail 🤔)
inventor96 Nov 5, 2019
f0fb480
Added instructions on how to update skills/agents
inventor96 Nov 10, 2019
013300a
Added customization step for Alexa skill updates
inventor96 Nov 11, 2019
78c0778
Added/updated TOC's
inventor96 Nov 15, 2019
ba012f9
Added note regarding the use of the Alexa online simulator
inventor96 Nov 19, 2019
c449d39
Handled 0 for pump reservoir
inventor96 Nov 23, 2019
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
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,13 +202,13 @@ Also if you can't code, it's possible to contribute by improving the documentati
| Release coordination 0.11.x: | [@PieterGit] |
| Issue/Pull request coordination: | Please volunteer |
| Cleaning up git fork spam: | Please volunteer |
| Documentation writers: | [@andrew-warrington][@unsoluble] [@tynbendad] [@danamlewis] [@rarneson] |
| Documentation writers: | [@andrew-warrington] [@unsoluble] [@tynbendad] [@danamlewis] [@rarneson] |

### Plugin contributors

| Contribution area | List of developers | List of testers
| ------------------------------------- | -------------------- | -------------------- |
| [`alexa` (Amazon Alexa)](README.md#alexa-amazon-alexa)| Please volunteer | Please volunteer |
| [`alexa` (Amazon Alexa)](README.md#alexa-amazon-alexa)| [@inventor96] | Please volunteer |
| [`ar2` (AR2 Forecasting)](README.md#ar2-ar2-forecasting)| Please volunteer | Please volunteer |
| [`basal` (Basal Profile)](README.md#basal-basal-profile)| Please volunteer | Please volunteer |
| [`boluscalc` (Bolus Wizard)](README.md#boluscalc-bolus-wizard)| Please volunteer | Please volunteer |
Expand All @@ -223,7 +223,7 @@ Also if you can't code, it's possible to contribute by improving the documentati
| [`direction` (BG Direction)](README.md#direction-bg-direction)| Please volunteer | Please volunteer |
| [`errorcodes` (CGM Error Codes)](README.md#errorcodes-cgm-error-codes)| Please volunteer | Please volunteer |
| [`food` (Custom Foods)](README.md#food-custom-foods)| Please volunteer | Please volunteer |
| [`googlehome` (Google Home)](README.md#google-home) |[@mdomox] [@rickfriele] | [@mcdafydd] [@oteroos] [@jamieowendexcom] |
| [`googlehome` (Google Home/DialogFlow)](README.md#googlehome-google-homedialogflow)| [@mdomox] [@rickfriele] [@inventor96] | [@mcdafydd] [@oteroos] [@jamieowendexcom] |
| [`iage` (Insulin Age)](README.md#iage-insulin-age)| Please volunteer | Please volunteer |
| [`iob` (Insulin-on-Board)](README.md#iob-insulin-on-board)| Please volunteer | Please volunteer |
| [`loop` (Loop)](README.md#loop-loop)| Please volunteer | Please volunteer |
Expand All @@ -232,9 +232,9 @@ Also if you can't code, it's possible to contribute by improving the documentati
| [`profile` (Treatment Profile)](README.md#profile-treatment-profile)| Please volunteer | Please volunteer |
| [`pump` (Pump Monitoring)](README.md#pump-pump-monitoring)| Please volunteer | Please volunteer |
| [`rawbg` (Raw BG)](README.md#rawbg-raw-bg)| [@jpcunningh] | Please volunteer |
| [`sage` (Sensor Age)](README.md#sage-sensor-age)| @jpcunningh | Please volunteer |
| [`sage` (Sensor Age)](README.md#sage-sensor-age)| [@jpcunningh] | Please volunteer |
| [`simplealarms` (Simple BG Alarms)](README.md#simplealarms-simple-bg-alarms)| Please volunteer | Please volunteer |
| [`speech` (Speech)](README.md#speech-speech) | [@sulkaharo] | Please volunteer |
| [`speech` (Speech)](README.md#speech-speech)| [@sulkaharo] | Please volunteer |
| [`timeago` (Time Ago)](README.md#timeago-time-ago)| Please volunteer | Please volunteer |
| [`treatmentnotify` (Treatment Notifications)](README.md#treatmentnotify-treatment-notifications)| Please volunteer | Please volunteer |
| [`upbat` (Uploader Battery)](README.md#upbat-uploader-battery)| [@jpcunningh] | Please volunteer |
Expand All @@ -251,7 +251,7 @@ Languages with less than 90% coverage will be removed in a future Nightscout ver
| Čeština (`cs`) |Please volunteer|OK |
| Deutsch (`de`) |[@viderehh] [@herzogmedia] |OK |
| Dansk (`dk`) | [@janrpn] |OK |
| Ελληνικά `(el`)|Please volunteer|Needs attention: 68.5%|
| Ελληνικά (`el`)|Please volunteer|Needs attention: 68.5%|
| English (`en`)|Please volunteer|OK|
| Español (`es`) |Please volunteer|OK|
| Suomi (`fi`)|[@sulkaharo] |OK|
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Community maintained fork of the
- [`override` (Override Mode)](#override-override-mode)
- [`xdrip-js` (xDrip-js)](#xdrip-js-xdrip-js)
- [`alexa` (Amazon Alexa)](#alexa-amazon-alexa)
- [`googlehome` (Google Home/DialogFLow)](#googlehome-google-homedialogflow)
- [`speech` (Speech)](#speech-speech)
- [`cors` (CORS)](#cors-cors)
- [Extended Settings](#extended-settings)
Expand Down Expand Up @@ -518,6 +519,9 @@ For remote overrides, the following extended settings must be configured:
##### `alexa` (Amazon Alexa)
Integration with Amazon Alexa, [detailed setup instructions](docs/plugins/alexa-plugin.md)

##### `googlehome` (Google Home/DialogFLow)
Integration with Google Home (via DialogFlow), [detailed setup instructions](docs/plugins/googlehome-plugin.md)

##### `speech` (Speech)
Speech synthesis plugin. When enabled, speaks out the blood glucose values, IOB and alarms. Note you have to set the LANGUAGE setting on the server to get all translated alarms.

Expand Down
62 changes: 62 additions & 0 deletions docs/plugins/add-virtual-assistant-support-to-plugin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Adding Virtual Assistant Support to a Plugin](#adding-virtual-assistant-support-to-a-plugin)
- [Intent Handlers](#intent-handlers)
- [Rollup handlers](#rollup-handlers)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Adding Virtual Assistant Support to a Plugin
=========================================

To add virtual assistant support to a plugin, the `init` method of the plugin should return an object that contains a `virtAsst` key. Here is an example:

```javascript
iob.virtAsst = {
intentHandlers: [{
intent: "MetricNow"
, metrics: ["iob"]
, intentHandler: virtAsstIOBIntentHandler
}]
, rollupHandlers: [{
rollupGroup: "Status"
, rollupName: "current iob"
, rollupHandler: virtAsstIOBRollupHandler
}]
};
```

There are 2 types of handlers that you can supply:
* Intent handler - Enables you to "teach" the virtual assistant how to respond to a user's question.
* A rollup handler - Enables you to create a command that aggregates information from multiple plugins. This would be akin to the a "flash briefing". An example would be a status report that contains your current bg, iob, and your current basal.

### Intent Handlers

A plugin can expose multiple intent handlers (e.g. useful when it can supply multiple kinds of metrics). Each intent handler should be structured as follows:
+ `intent` - This is the intent this handler is built for. Right now, the templates used by both Alexa and Google Home use only the `"MetricNow"` intent (used for getting the present value of the requested metric)
+ `metrics` - An array of metric name(s) the handler will supply. e.g. "What is my `metric`" - iob, bg, cob, etc. Make sure to add the metric name and its synonyms to the list of metrics used by the virtual assistant(s).
- **IMPORTANT NOTE:** There is no protection against overlapping metric names, so PLEASE make sure your metric name is unique!
- Note: Although this value *is* an array, you really should only supply one (unique) value, and then add aliases or synonyms to that value in the list of metrics for the virtual assistant. We keep this value as an array for backwards compatibility.
+ `intenthandler` - This is a callback function that receives 3 arguments:
- `callback` Call this at the end of your function. It requires 2 arguments:
- `title` - Title of the handler. This is the value that will be displayed on the Alexa card (for devices with a screen). The Google Home response doesn't currently display a card, so it doesn't use this value.
- `text` - This is text that the virtual assistant should speak (and show, for devices with a screen).
- `slots` - These are the slots (Alexa) or parameters (Google Home) that the virtual assistant detected (e.g. `pwd` as seen in the templates is a slot/parameter. `metric` is technically a slot, too).
- `sandbox` - This is the Nightscout sandbox that allows access to various functions.

### Rollup handlers

A plugin can also expose multiple rollup handlers
+ `rollupGroup` - This is the key that is used to aggregate the responses when the intent is invoked
+ `rollupName` - This is the name of the handler. Primarily used for debugging
+ `rollupHandler` - This is a callback function that receives 3 arguments
- `slots` - These are the values of the slots. Make sure to add these values to the appropriate custom slot
- `sandbox` - This is the nightscout sandbox that allows access to various functions.
- `callback` -
- `error` - This would be an error message
- `response` - A simple object that expects a `results` string and a `priority` integer. Results should be the text (speech) that is added to the rollup and priority affects where in the rollup the text should be added. The lowest priority is spoken first. An example callback:
```javascript
callback(null, {results: "Hello world", priority: 1});
```
Loading