Public Member Functions | Public Attributes | List of all members
mycroft.client.enclosure.mark1.EnclosureReader Class Reference
Inheritance diagram for mycroft.client.enclosure.mark1.EnclosureReader:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, serial, bus, lang=None)
 
def on_stop_handled (self, event)
 
def process (self, data)
 
def read (self)
 
def stop (self)
 

Public Attributes

 alive
 
 bus
 
 daemon
 
 lang
 
 serial
 

Detailed Description

Reads data from Serial port.

Listens to all commands sent by Arduino that must be be performed on
Mycroft Core.

E.g. Mycroft Stop Feature
    #. Arduino sends a Stop command after a button press on a Mycroft unit
    #. ``EnclosureReader`` captures the Stop command
    #. Notify all Mycroft Core processes (e.g. skills) to be stopped

Note: A command is identified by a line break

Definition at line 48 of file scripts/mycroft/client/enclosure/mark1/__init__.py.

Constructor & Destructor Documentation

def mycroft.client.enclosure.mark1.EnclosureReader.__init__ (   self,
  serial,
  bus,
  lang = None 
)

Member Function Documentation

def mycroft.client.enclosure.mark1.EnclosureReader.on_stop_handled (   self,
  event 
)
def mycroft.client.enclosure.mark1.EnclosureReader.process (   self,
  data 
)
def mycroft.client.enclosure.mark1.EnclosureReader.read (   self)
def mycroft.client.enclosure.mark1.EnclosureReader.stop (   self)

Member Data Documentation

mycroft.client.enclosure.mark1.EnclosureReader.alive
mycroft.client.enclosure.mark1.EnclosureReader.bus
mycroft.client.enclosure.mark1.EnclosureReader.daemon
mycroft.client.enclosure.mark1.EnclosureReader.lang
mycroft.client.enclosure.mark1.EnclosureReader.serial

The documentation for this class was generated from the following file:


mycroft_ros
Author(s):
autogenerated on Mon Apr 26 2021 02:35:40