中文 | English
This module encapsulates some common components and base classes for use by other modules.
option_lockfunction lock decoratorSingletonsingleton base classGPIOCtrlGPIO control base class
Function lock decorator, used for functions that require locking.
Example:
import _thread
from common import option_lock
_fun_lock = _thread.allocate_lock()
@option_lock(_fun_lock)
def test_lock_fun(args):
print(args)Parameters:
| Parameter | Type | Description |
|---|---|---|
| thread_lock | object | Thread lock instance object |
Singleton base class. When you need to control a class so that it is not instantiated multiple times throughout the project, you can inherit this class to achieve the function of not being instantiated multiple times.
Example:
from common import Singleton
class TestOne(Singleton):
pass
class TestTwo(Singleton):
pass
a = TestOne()
b = TestOne()
c = TestTwo()
d = TestTwo()
print(a)
# <TestOne object at 7e842d40>
print(b)
# <TestOne object at 7e842d40>
print(c)
# <TestTwo object at 7e842eb0>
print(d)
# <TestTwo object at 7e842eb0>GPIO control base class. This base class can be used to control the high and low levels of GPIO, thereby controlling peripheral functions such as switches, repetitive switches, etc., such as LED lights, Buzzer buzzers, etc.
Example:
from common import GPIOCtrl
class LED(GPIOCtrl):
def __init__(self):
super().__init__()
class Buzzer(GPIOCtrl):
def __init__(self):
super().__init__()Taking the LED as an example, the interface is explained.
Example:
from led import LED
yellow_led = LED()Current GPIO level status, 1 high level (LED on / Buzzer on), 0 low level (LED off / Buzzer off).
Example:
state = yellow_led.state
print(state)
# 1Return Value:
| Data Type | Description |
|---|---|
| int | 1 - High level 0 - Low level |
Add the GPIO that controls the current LED. Since multiple GPIOs may control one color light, this method is used to achieve this. For example, a yellow light is displayed by simultaneously lighting up red and green, so two GPIOs need to be added.
Example:
from machine import Pin
red_gpio = Pin(Pin.GPIO1, Pin.OUT, Pin.PULL_DISABLE, 0)
green_gpio = Pin(Pin.GPIO2, Pin.OUT, Pin.PULL_DISABLE, 0)
yellow_led.add_gpio(red_gpio)
# True
yellow_led.add_gpio(green_gpio)
# TrueParameters:
| Parameter | Type | Description |
|---|---|---|
| gpio | object | GPIO object |
Return Value:
| Data Type | Description |
|---|---|
| bool | True - SuccessFalse - Failure |
Get the list of all GPIO objects controlling the current GPIO module.
Example:
yellow_led.get_gpio()
# [<GPIO(1)>, <GPIO(2)>]Return Value:
| Data Type | Description |
|---|---|
| list | List of GPIO objects |
Turn on the GPIO control module, setting all control GPIO pins to high level.
Example:
yellow_led.on()
# TrueParameters:
None
Return Value:
| Data Type | Description |
|---|---|
| bool | True - SuccessFalse - Failure |
Turn off the GPIO control module, setting all control GPIO pins to low level.
Example:
yellow_led.off()
# TrueParameters:
None
Return Value:
| Data Type | Description |
|---|---|
| bool | True - SuccessFalse - Failure |
Start the GPIO control module to periodically switch high and low levels (LED flickering / Buzzer periodic switching).
Example:
on_period = 100
off_period = 200
count = 20
yellow_led.start_flicker(on_period, off_period, count)
# TrueParameters:
| Parameter | Type | Description |
|---|---|---|
| on_period | int | High level duration (LED on / Buzzer on) |
| off_period | int | Low level duration (LED off / Buzzer off) |
| count | int | Number of switches, set to 0 for continuous switching |
Return Value:
| Data Type | Description |
|---|---|
| bool | True - SuccessFalse - Failure |
Stop the GPIO control module from periodically switching high and low levels (LED flickering / Buzzer periodic switching).
Example:
yellow_led.stop_flicker()
# TrueParameters:
None
Return Value:
| Data Type | Description |
|---|---|
| bool | True - SuccessFalse - Failure |