70 lines
1.9 KiB
Python
70 lines
1.9 KiB
Python
# Copyright 2020 Mycroft AI Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import abc
|
|
|
|
|
|
class MycroftLed:
|
|
""" abstract base class for a Mycroft Led
|
|
all leds must provide at least these basic methods """
|
|
__metaclass__ = abc.ABCMeta
|
|
|
|
@abc.abstractmethod
|
|
def __init__(self):
|
|
return
|
|
|
|
@abc.abstractmethod
|
|
def set_led(self, which_led, color, immediate):
|
|
"""Set the color of a specific LED.
|
|
|
|
Arguments:
|
|
which_led (Int): the index of the LED to be changed
|
|
color (Tuple): the RGB color as a three integer Tuple
|
|
immediate (Bool): whether to change now or wait for the next call of show()
|
|
"""
|
|
return
|
|
|
|
@abc.abstractmethod
|
|
def fill(self, color):
|
|
"""set all leds to the supplied color
|
|
Arguments:
|
|
color (Tuple): the RGB color as a three integer Tuple
|
|
"""
|
|
return
|
|
|
|
@abc.abstractmethod
|
|
def show(self):
|
|
"""update leds from buffered data"""
|
|
return
|
|
|
|
@abc.abstractmethod
|
|
def get_led(self, which_led):
|
|
"""returns current buffered value"""
|
|
return
|
|
|
|
@abc.abstractmethod
|
|
def set_leds(self, leds):
|
|
"""updates buffer from leds and update hardware
|
|
Arguments:
|
|
|
|
leds [(of tuples),()]: the RGB color as a three integer Tuple
|
|
"""
|
|
return
|
|
|
|
@abc.abstractmethod
|
|
def get_capabilities(self):
|
|
"""returns capabilities object"""
|
|
return
|
|
|