From b2b0e618ac0458ff3bb4798e8aebaaaeb702f14b Mon Sep 17 00:00:00 2001 From: watson8544 <854410664@qq.com> Date: Mon, 6 Aug 2018 12:05:38 +0800 Subject: [PATCH] updated "API Reference" --- en/api-reference/button/button.rst | 70 ++++++++++ en/api-reference/index.rst | 5 + en/api-reference/peripherals/adc.rst | 65 ++++++++++ en/api-reference/peripherals/dac.rst | 69 ++++++++++ en/api-reference/peripherals/gpio.rst | 27 ++++ en/api-reference/peripherals/index.rst | 13 ++ en/api-reference/peripherals/neopixel.rst | 116 +++++++++++++++++ en/api-reference/peripherals/spi.rst | 120 ++++++++++++++++++ en/api-reference/peripherals/timer.rst | 0 en/api-reference/peripherals/uart.rst | 0 en/api-reference/speaker/speaker.rst | 60 +++++++++ en/index.rst | 10 +- en/product-documents/index.rst | 4 + .../modules/m5stack_btc_module.rst | 29 +++++ .../modules/m5stack_proto_kit.rst | 66 ++++++++++ .../modules/m5stack_proto_module.rst | 72 +++++++++++ .../tools/m5stack_usb_downloader.rst | 46 +++++++ 17 files changed, 767 insertions(+), 5 deletions(-) create mode 100644 en/api-reference/button/button.rst create mode 100644 en/api-reference/peripherals/adc.rst create mode 100644 en/api-reference/peripherals/dac.rst create mode 100644 en/api-reference/peripherals/gpio.rst create mode 100644 en/api-reference/peripherals/index.rst create mode 100644 en/api-reference/peripherals/neopixel.rst create mode 100644 en/api-reference/peripherals/spi.rst create mode 100644 en/api-reference/peripherals/timer.rst create mode 100644 en/api-reference/peripherals/uart.rst create mode 100644 en/api-reference/speaker/speaker.rst create mode 100644 en/product-documents/modules/m5stack_btc_module.rst create mode 100644 en/product-documents/modules/m5stack_proto_kit.rst create mode 100644 en/product-documents/modules/m5stack_proto_module.rst create mode 100644 en/product-documents/tools/m5stack_usb_downloader.rst diff --git a/en/api-reference/button/button.rst b/en/api-reference/button/button.rst new file mode 100644 index 00000000..c9f95227 --- /dev/null +++ b/en/api-reference/button/button.rst @@ -0,0 +1,70 @@ +Button API +*********** + +----------------------------- + +Function +--------- + +isPressed() + +isReleased() + +pressedFor(timeout) + +wasPressed(callback=None) +wasReleased(callback=None) +releasedFor(timeout, callback=None) + + + +--------------------- + +Usage +------ + +.. code:: python + + from m5stack import * + from machine import SPI, Pin + from display import LCD + import utime + + spi = SPI(1, baudrate=32000000, mosi=Pin(23), miso=Pin(19), sck=Pin(18)) + + lcd = LCD(spi = spi) #lcd init + + while True: + if buttonA.wasPressed(): + lcd.print('Button A was Pressed\n') + + if buttonA.wasReleased(): + lcd.print('Button A was Released\n') + + if buttonA.pressedFor(1.5): + lcd.print('Button A pressed for 1.5s\n') + + if buttonA.releasedFor(2): + lcd.print('Button A released for 2s press hold\n') + + utime.sleep(0.1) + + +.. code:: python + + #Button Callback + + from m5stack import * + + def on_wasPressed(): + lcd.print('Button B was Pressed\n') + + def on_wasReleased(): + lcd.print('Button B was Released\n') + + def on_releasedFor(): + lcd.print('Button B released for 1.2s press hold\n') + + buttonB.wasPressed(on_wasPressed) + buttonB.wasReleased(on_wasReleased) + buttonB.releasedFor(1.2, on_releasedFor) diff --git a/en/api-reference/index.rst b/en/api-reference/index.rst index 793f0410..ec10abb0 100644 --- a/en/api-reference/index.rst +++ b/en/api-reference/index.rst @@ -6,6 +6,11 @@ API Reference :maxdepth: 1 LCD + Button