jvsdisplayotron
Version:
A lightweight but powerful module, that allows you to easily control a Display-O-Tron 3000 / HAT from Node.js
28 lines (21 loc) • 807 B
Markdown
<a name="DOT3k"></a>
## DOT3k
**Kind**: global class
* [DOT3k](#DOT3k)
* [new DOT3k()](#new_DOT3k_new)
* [.reset()](#DOT3k+reset)
* [.kill([performReset])](#DOT3k+kill)
<a name="new_DOT3k_new"></a>
### new DOT3k()
Creates a new `DOT3k` object.
<a name="DOT3k+reset"></a>
### dot3k.reset()
Resets the Display-O-Tron.
**Kind**: instance method of <code>[DOT3k](#DOT3k)</code>
<a name="DOT3k+kill"></a>
### dot3k.kill([performReset])
Kills the Python process used by JVSDisplayOTron.
**Kind**: instance method of <code>[DOT3k](#DOT3k)</code>
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [performReset] | <code>Boolean</code> | <code>false</code> | A value that indicates whether a reset should be performed prior to killing the process. Optional (false by default). |