Module `src.main.python.motor`

Expand source code

import machine
from actuator import Actuator


class Motor(Actuator):

    """Motor DC rotates in one direction with current , it's a "one pin controller" """

    def __init__(self, pin_num, running=False):
        """ constructor.
        :param pin_num: number of pin that will give power to the motor
        :param running: the initial condition of the motor
        """
        self.pin = machine.Pin(pin_num, machine.Pin.OUT)
        self.running = running
        self.pin.value(running)  # 1 to run, 0 to stop

    def __str__(self):
        """prints the object."""
        return "Motor currently is running: {}".format(self.running)

    def on(self):
        """starts motor."""
        self.pin.on()
        self.running = True

    def off(self):
        """stops motor."""
        self.pin.off()
        self.running = False

    def is_running(self):
        """if the motor is running or not."""
        return self.running

Classes

class Motor (pin_num, running=False)

Motor DC rotates in one direction with current , it's a "one pin controller"

constructor. :param pin_num: number of pin that will give power to the motor :param running: the initial condition of the motor

Expand source code

class Motor(Actuator):

    """Motor DC rotates in one direction with current , it's a "one pin controller" """

    def __init__(self, pin_num, running=False):
        """ constructor.
        :param pin_num: number of pin that will give power to the motor
        :param running: the initial condition of the motor
        """
        self.pin = machine.Pin(pin_num, machine.Pin.OUT)
        self.running = running
        self.pin.value(running)  # 1 to run, 0 to stop

    def __str__(self):
        """prints the object."""
        return "Motor currently is running: {}".format(self.running)

    def on(self):
        """starts motor."""
        self.pin.on()
        self.running = True

    def off(self):
        """stops motor."""
        self.pin.off()
        self.running = False

    def is_running(self):
        """if the motor is running or not."""
        return self.running

Ancestors

actuator.Actuator

Methods

def is_running(self)

if the motor is running or not.

Expand source code

def is_running(self):
    """if the motor is running or not."""
    return self.running

def off(self)

stops motor.

Expand source code

def off(self):
    """stops motor."""
    self.pin.off()
    self.running = False

def on(self)

starts motor.

Expand source code

def on(self):
    """starts motor."""
    self.pin.on()
    self.running = True