m5/m5-docs
0
0
Fork 0
mirror of https://github.com/m5stack/m5-docs.git synced 2026-05-20 10:23:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

add api(timer, uart) faq

Browse Source
This commit is contained in:
watson8544
2018-08-06 23:11:00 +08:00
parent b2b0e618ac
commit 439da1284d
7 changed files with 248 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
en/api-reference/peripherals/timer.rst
+113
View File
@@ -0,0 +1,113 @@
Timer API
**********
-----------------------------
Description
------------
The ESP32 chip contains two hardware timer groups. Each group has two general-purpose hardware timers. They are all 64-bit generic timers based on 16-bit prescalers and 64-bit auto-reload-capable up / down counters.
*Note: Due to MicroPython callback latency, some callbacks may not be executed if the timer period is less than 15 ms.
The number of events and executed callbacks can be checked using tm.events() method.*
-----------------------------
Function
---------
machine.Timer(timer_no)
>>>>>>>>>>>>>>>>>>>>>>>>
| **Description:** 　　
| Create the Timer instance object
| **Parament:**
| **timer_no:** the timer number to be used for the timer
| **Example:**
.. code:: python
import machine
p1 = machine.Pin(27)
init(period, mode, callback, dbgpin)
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
| **Description:** 　　
| initialize paraments of the timer
| **Parament:**
| **period:** Timer period(Default: 10 ms)
| *Note: Timer period in ms, only used for PERIODIC and ONE_SHOT timers*
| **mode:** Timer mode of operation(Default: PERIODIC)
| **callback:** The Python callback function to be executed on timer event(Default: None)
| **dbgpin:** GPIO pin to be used as debug output(Default: -1 (not used))
| *Note: If used, the gpio level will toggle on each timer event*
| **Return:**
| None
| **Example:**
.. code:: python
from machine import SPI, Pin
spi = SPI(
spihost=SPI.HSPI,
baudrate=2600000
sck=Pin(18),
mosi=Pin(23),
miso=Pin(19),
cs=Pin(4)
)
spi.write(buf) #NOHEAP
value()
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
| **Description:** 　　
| **Return:**
| Returns the current timer counter value in **µs** if timer mode is CHRONO or in **ms** for other modes
| **Example:**
.. code:: python
import machine
p1 = machine.Pin(27)
p1.init(p1.OUT)
p1.value(1)
---------------------
Usage
------
.. code:: python
import machine
tcounter = 0
p1 = machine.Pin(27)
p1.init(p1.OUT)
p1.value(1)
def tcb(timer):
global tcounter
if tcounter & 1:
p1.value(0)
else:
p1.value(1)
tcounter += 1
if (tcounter % 10000) == 0:
print("[tcb] timer: {} counter: {}".format(timer.timernum(), tcounter))
t1 = machine.Timer(2)
t1.init(period=20, mode=t1.PERIODIC, callback=tcb)
en/api-reference/peripherals/uart.rst
+108
View File
@@ -0,0 +1,108 @@
UART API
*********
-----------------------------
Description
------------
An Universal Asynchronous Receiver/Transmitter (UART) is a component known to handle the timing requirements for a variety of widely-adapted protocols (RS232, RS485, RS422, …).
An UART provides a widely adopted and cheap method to realize full-duplex data exchange among different devices.
There are three UART controllers available on the ESP32 chip. They are compatible with UART-enabled devices from various manufacturers. All UART controllers integrated in the ESP32 feature an identical set of registers for ease of programming and flexibility. In this documentation, these controllers are referred to as UART0, UART1, and UART2.
-----------------------------
Function
---------
machine.UART(uart_num, tx=pin, rx=pin [,args])
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
| **Description:** 　　
| Create the uart instance object
| **Parament:**
| **uart_num:** The hardware SPI host. machine-SPI.HSPI (1) or machine.SPI.VSPI (2) can be used. Default: 1
| **tx:** the gpio used for tx
| **rx:** the gpio used for rx
| **Example:**
.. code:: python
from machine import UART
uart2 = UART(2, tx=17, rx=16)
uart2.init(115200, bits=8, parity=None, stop=1)
write(buf [, len [, off]])
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
| **Description:** 　　
| Write bytes from buffer object ḃuf to UART
| **Parament:**
| **buf:** data buffer to be write
| **len:** writes `ŀen` bytes
| **off:** starts writting from `off` position in `buf`
| **Example:**
.. code:: python
from machine import UART
uart2 = UART(2, tx=17, rx=16)
uart2.init(115200, bits=8, parity=None, stop=1)
uart2.write('abc') # write the 3 characters
read()
>>>>>>>
| **Description:** 　　
| read all available characters
| **Example:**
.. code:: python
from machine import UART
uart2 = UART(2, tx=17, rx=16)
uart2.init(115200, bits=8, parity=None, stop=1)
uart2.read() # read all available characters
readline([max_len])
>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
| **Description:** 　　
| Reads all bytes from the receive buffer up to the line end character **\n**
| **Parament:**
| **max_len:** maximum length to be read
| **Example:**
.. code:: python
from machine import UART
uart2 = UART(2, tx=17, rx=16)
uart2.init(115200, bits=8, parity=None, stop=1)
uart2.readline() # read a line
---------------------
Usage
------
.. code:: python
from machine import UART
uart2 = UART(2, tx=17, rx=16)
uart2.init(115200, bits=8, parity=None, stop=1)
uart2.read(10) # read 10 characters, returns a bytes object
uart2.read() # read all available characters
uart2.readline() # read a line
uart2.readinto(buf) # read and store into the given buffer
uart2.write('abc') # write the 3 characters
en/basic-cases/m5stack-core/m5stack_core_cases.md
+9
View File
@@ -0,0 +1,9 @@
### M5Stack Game
#### 1. M5Stack-nesemu
This is a quick and dirty port of Nofrendo, a Nintendo Entertainment System emulator. It lacks sound, but can emulate a NES at close to full speed, albeit with some framedrop due to the way the display is driven.
https://github.com/m5stack/M5Stack-nesemu
en/get-started/get-started-ESP32CAM.md
+3 -3
View File
@@ -6,17 +6,17 @@ It is really really out of the box. Your ESP32CAM will immediately run without a
1. plug usb cable into ESP32CAM and open the serial terminal on your computer.
![image](screenshots/ESP32CAM_Terminal.png)
![image](../../_static/screenshots/ESP32CAM_Terminal.png)
2. Then waitting a few seconds, you connect to a AP named "`M5CAM`" with your computer(or mobile phone).
![image](screenshots/ESP32CAM_M5CAM.png)
![image](../../_static/screenshots/ESP32CAM_M5CAM.png)
3. And you open the browser on the computer(or mobile phone), enter a URL `http://192.168.4.1`. At the moment, your can see the real-time transmission of video by ESP32CAM on the browser.
![image](screenshots/ESP32CAM_Browser.png)
![image](../../_static/screenshots/ESP32CAM_Browser.png)
Now, A WebCam you achieved successfully !
en/m5stack-faq/M5Stack-Core/m5stack_core.md
+4
View File
@@ -0,0 +1,4 @@
#### Q1. How use RGB LED on M5 FIRE?
*Thank you for being interested in our products and services, Please contact us by [tech support email](tech@m5stack.com) or [forum](forum.m5stack.com) if you need any assistance.*
en/m5stack-faq/index.rst
+3 -1
View File
@@ -6,4 +6,6 @@ M5Stack-FAQ
:maxdepth: 2
m5stack-core <m5stack-core/index>
m5stack-module <m5stack-module/index>
m5stack-module <m5stack-module/index>
`Thank you for being interested in our products and services, Please contact us by `tech support email <tech@m5stack.com>`_ or `forum <forum.m5stack.com>`_ if you need any assistance.`
en/m5stack-faq/others_faq.md
+8
View File
@@ -0,0 +1,8 @@
#### Q1. How to set up PlatformIO for M5Stack development?
A: https://github.com/m5stack/M5Stack-platformio
#### Q2. Cannot boot M5Cloud firmware on M5Stack FIRE on Windows PC using flash download tool?
*Thank you for being interested in our products and services, Please contact us by [tech support email](tech@m5stack.com) or [forum](forum.m5stack.com) if you need any assistance.*