Back to Metrics

README

source/plugins/community/nightscout/README.md

3.344.1 KB
Original Source
<!--header--> <table> <tr><td colspan="2"><a href="/README.md#-plugins">← Back to plugins index</a></td></tr> <tr><th colspan="2"><h3>💉 Nightscout</h3></th></tr> <tr><td colspan="2" align="center"><p>This plugin displays blood sugar values from a <a href="http://nightscout.info">Nightscout</a> site.</p> </td></tr> <tr><th>⚠️ Disclaimer</th><td><p>This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with <a href="http://nightscout.info">Nightscout</a>. All product and company names are trademarks™ or registered® trademarks of their respective holders.</p> </td></tr> <tr><th>Authors</th><td><a href="https://github.com/legoandmars">@legoandmars</a></td></tr> <tr> <th rowspan="3">Supported features <sub><a href="metadata.yml">→ Full specification</a></sub></th> <td><a href="/source/templates/classic/README.md"><code>📗 Classic template</code></a></td> </tr> <tr> <td><code>👤 Users</code></td> </tr> <tr> <td><i>No tokens are required for this plugin</i></td> </tr> <tr> <td colspan="2" align="center"> </img>
</td>
</tr> </table> <!--/header-->

➡️ Available options

<!--options--> <table> <tr> <td align="center" nowrap="nowrap">Option</i></td><td align="center" nowrap="nowrap">Description</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_nightscout</code></h4></td> <td rowspan="2"><p>Enable nightscout plugin</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>boolean</code>

<b>default:</b> no

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_nightscout_url</code></h4></td> <td rowspan="2"><p>Nightscout URL</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>string</code>

<b>default:</b> https://example.herokuapp.com

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_nightscout_datapoints</code></h4></td> <td rowspan="2"><p>Number of datapoints shown the graph</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥)</i>

<b>zero behaviour:</b> disable</br> <b>default:</b> 12

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_nightscout_lowalert</code></h4></td> <td rowspan="2"><p>Threshold for low blood sugar</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥)</i>

<b>default:</b> 80

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_nightscout_highalert</code></h4></td> <td rowspan="2"><p>Threshold for high blood sugar</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥)</i>

<b>default:</b> 180

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_nightscout_urgentlowalert</code></h4></td> <td rowspan="2"><p>Threshold for urgently low blood sugar</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥)</i>

<b>default:</b> 50

</td> </tr> <tr> <td nowrap="nowrap"><h4><code>plugin_nightscout_urgenthighalert</code></h4></td> <td rowspan="2"><p>Threshold for urgently high blood sugar</p> </td> </tr> <tr> <td nowrap="nowrap"><b>type:</b> <code>number</code> <i>(0 ≤ 𝑥)</i>

<b>default:</b> 250

</td> </tr> </table> <!--/options-->

🌐 Setup a Nightscout instance

The nightscout website details how to self-host a nightscout site. Check out the instructions there.

ℹ️ Examples workflows

<!--examples-->
yaml
uses: lowlighter/metrics@latest
with:
  token: NOT_NEEDED
  plugin_nightscout: yes
  plugin_nightscout_url: ${{ secrets.NIGHTSCOUT_URL }}

<!--/examples-->