| /hal_espressif-3.5.0/docs/en/api-reference/protocols/ |
| D | modbus.rst | 20 …master(s) and slave devices (multiple masters are allowed on using Modbus TCP/IP). The slave devic…
30 …hat the number of slaves and their register maps are known by the Modbus master before the start o…
44 …us`. The sections cover initialization of a Modbus port, and the setup a master or slave device ac…
46 - :ref:`modbus_api_port_initialization`
47 - :ref:`modbus_api_slave_overview`
48 - :ref:`modbus_api_master_overview`
55 …e used to create and then initialize Modbus controller interface (either master or slave) over a p…
68 // Initialization of Modbus master for serial port
70 if (master_handler == NULL || err != ESP_OK) {
81 if (slave_handler == NULL || err != ESP_OK) {
[all …]
|
| D | esp_serial_slave_link.rst | 9 designed for the master to communicate with ESP slave devices through those protocols over the
33 - ESSL device: a virtual device on the master associated with an ESP slave device. The device
39 communication state, data shared by master and slave, etc.
41 …The context should be initialized before it is used, and get deinitialized if not used any more. T…
42 master application operates on the ESSL device through this handle.
47 - Bus: The bus over which the master and the slave communicate with each other.
51 - TX buffer num: a counter, which is on the slave and can be read by the master, indicates the
53 master.
55 - RX data size: a counter, which is on the slave and can be read by the master, indicates the
56 accumulated data size that the slave has loaded to the hardware to send to the master.
[all …]
|
| D | esp_spi_slave_protocol.rst | 33 In the half duplex mode, the master has to use the protocol defined by the slave to communicate
37 - Command: 8-bit, master to slave
39 … This phase determines the rest phases of the transactions. See :ref:`spi_slave_hd_supported_cmds`.
41 - Address: 8-bit, master to slave, optional
49 This phase is the turn around time between the master and the slave on the bus, and also
50 provides enough time for the slave to prepare the data to send to master.
54 This may be a data OUT phase, in which the direction is slave to master, or a data IN phase,
55 in which the direction is master to slave.
57 The *direction* means which side (master or slave) controls the MOSI, MISO, WP and HD pins.
83 Normally, which mode is used is determined is determined by the command sent by the master (See
[all …]
|
| /hal_espressif-3.5.0/docs/en/ |
| D | versions.rst | 6 The ESP-IDF GitHub repository is updated regularly, especially the master branch where new developm…
18 Documentation for the latest version (master branch) can always be found at this URL:
42 …e `latest version (master branch in Git) <https://docs.espressif.com/projects/esp-idf/en/latest/>`…
44 …master branch, it is possible to check out a pre-release version or a release branch. It is recomm…
46 See :ref:`updating` if you already have a local copy of ESP-IDF and wish to update it.
126 …ormation is not always updated if the code in the GitHub repo is updated, it only changes if there…
128 …ltiple ESP-IDF versions, the version can be checked at compile time using :ref:`compile-time macro…
140 ``v3.1-beta1-75-g346d6b0ea`` | Beta version in development (on a :ref:`release branch <updating-rel…
154 - New work is always added on the master branch (latest version) first. The ESP-IDF version on ``ma…
156 - When a new version (developed on ``master``) becomes feature complete and "beta" quality, a new b…
[all …]
|
| /hal_espressif-3.5.0/docs/en/api-reference/peripherals/ |
| D | i2c.rst | 15 …ponsible for handling communications on I2C bus. The I2C controller can operate as master or slave.
19 …2C bus. Each I2C controller can operate as master or slave. As an example, one controller can act …
28 - Reading and writing to registers which are in turn read/written by the master
36 1. :ref:`i2c-api-configure-driver` - set the initialization parameters (master or slave mode, GPIO …
37 2. :ref:`i2c-api-install-driver`- activate the driver on one of the two I2C controllers as a master…
38 3. Depending on whether you configure the driver for a master or slave, choose the appropriate item
40 a) :ref:`i2c-api-master-mode` - handle communications (master)
41 b) :ref:`i2c-api-slave-mode` - respond to messages from the master (slave)
43 4. :ref:`i2c-api-interrupt-handling` - configure and service I2C interrupts
44 5. :ref:`i2c-api-customized-configuration` - adjust default I2C communication parameters (timings, …
[all …]
|
| D | spi_master.rst | 21 :ref:`spi_master_on_spi1_bus`.
42 The terms used in relation to the SPI master driver are given in the table below.
49 …ach Device has its own CS line. Several Devices can also share one CS line if connected in the dai…
71 The SPI master driver governs communications of Hosts with Devices. The driver supports the followi…
75 …multiplexing of data coming from different Devices on the same signal bus, see :ref:`spi_bus_lock`.
79 …master driver has the concept of multiple Devices connected to a single bus (sharing a single {IDF…
123 …a command and/or address. This is reflected in the Device's configuration: if :cpp:member:`command…
127 …tion type per Device. If your Device requires both transaction types, see :ref:`mixed_transactions…
149 …unc:`spi_device_release_bus` to avoid the overhead. For more information, see :ref:`bus_acquiring`.
156 …saction_t` as shown in the `Transaction Flag` column. If you want to check if corresponding IO pin…
[all …]
|
| D | spi_slave_hd.rst | 9 …master, while the direction of the data phase depends on the command. The data phase can be either…
11 About the details of how master should communicate with the SPI Slave, see :doc:`/api-reference/pro…
13 By these different transactions, the slave provide these services to the master:
15 - A DMA channel for the master to write a great amount of data to the slave.
16 - A DMA channel for the master to read a great amount of data from the slave.
17 - Several general purpose registers, shard between the master and the slave.
18 - Several general purpose interrupts, for the master to interrupt the SW of slave.
32 - Transaction read/write by master in segments
54 …master through the sending DMA channel, the application should properly wrap the data to send by a…
56 …. This function will block until the transaction with command RDDMA from master successfully compl…
[all …]
|
| D | spi_slave.rst | 12 …o general purpose SPI controllers which can be used as slave nodes driven by an off-chip SPI master
23 …SPI controller which can be used as slave node driven by an off-chip SPI master. The controller is…
36 …ach Device has its own CS line. Several Devices can also share one CS line if connected in the dai…
56 … utilize DMA to send/receive longer transactions. However, there are some :ref:`known issues <spi_…
70 …PIO pin for a handshake signal to sync the Devices. For more details, see :ref:`transaction_interv…
115 …the influence of the MISO input delay on the maximum clock frequency, see :ref:`timing_considerati…
163 …_TARGET_MAX_FREQ} MHz. The data cannot be recognized or received correctly if the clock is too fas…
170 …The Device can read data correctly only if the data is already set at the launch edge. Although it…
188 …Exception: The frequency is allowed to be higher if the master has more tolerance for the MISO set…
196 …correctly or not in a boundary aligned manner. The driver reports an error if this condition is no…
[all …]
|
| D | sd_pullup_requirements.rst | 10 …in is incompatible with the DAT2 line pull-up if the flash voltage is 3.3 V. For more information,…
28 …hese issues should be resolved regardless of whether they are related to master (host) or slave (d…
38 - :ref:`sd_pull-up_no_pull-ups`
39 - :ref:`strapping_conflicts_dat2` for models with 3.3 V flash chip
43 - :ref:`sd_pull-up_no_pull-ups`
44 - :ref:`no_pull-up_on_gpio12`
67 - :ref:`sd_pull-up_no_pull-ups`
68 - :ref:`strapping_conflicts_dat2`
78 - :ref:`sd_pull-up_no_pull-ups`
79 - :ref:`strapping_conflicts_dat2`
[all …]
|
| D | twai.rst | 16 1. :ref:`twai-protocol-summary`
18 2. :ref:`signals-lines-and-transceiver`
20 3. :ref:`configuration`
22 4. :ref:`driver-operation`
24 5. :ref:`examples`
34 The TWAI is a multi-master, multi-cast, asynchronous, serial communication protocol. TWAI also supp…
36 **Multi-master:** Any node on the bus can initiate the transfer of a message.
156 …ging is disabled and ``TWAI_ALERT_AND_LOG`` if the :ref:`CONFIG_TWAI_ISR_IN_IRAM` option is enable…
176 …rt any multiple of 4 from 132 to 256**, and can be enabled by setting the :ref:`CONFIG_ESP32_REV_M…
264 - Enable the :ref:`CONFIG_TWAI_ISR_IN_IRAM` option using ``idf.py menuconfig``.
[all …]
|
| D | touch_pad.rst | 10 …n a user touches the surface, the capacitance variation is used to evaluate if the touch was valid.
28 …uide for ESP32-Sense-Kit <https://github.com/espressif/esp-dev-kits/blob/master/esp32-sense-kit/do…
44 …ction, please go to Section :ref:`touch_pad-api-reference`. Practical implementation of this API i…
50 …ers listed in :ref:`touch_pad-api-reference` under *Macros*. It also removes the information about…
59 Use the function :cpp:func:`touch_pad_set_fsm_mode` to select if touch pad measurement (operated by…
149 …lay sensor measurements when a pad is touched and released. Apply a filter if measurements are noi…
168 …and are implemented in hardware. Enabling the software filtering API (see :ref:`touch_pad-api-filt…
|
| D | sdio_slave.rst | 41 .. note:: Please check if CMD and DATA lines D0-D3 of the card are properly
45 :ref:`compatibility_overview_espressif_hw_sdio` to see whether your
51 for the first time. See :ref:`compatibility_overview_espressif_hw_sdio` to
107 …If the application reads from a buffer owned by a receiving driver, the data read can be random; if
120 and from slave to host (called host interrupts below). See more in :ref:`interrupts`.
129 briefly in :ref:`esp_slave_init`.
132 Func 1. Please refer to :ref:`esp_slave_protocol_layer`. There is also a component
134 for ESP32 master to communicate with ESP32 SDIO slave, see example :example:`peripherals/sdio`
277 Slave/master communication: :example:`peripherals/sdio`.
|
| /hal_espressif-3.5.0/docs/zh_CN/api-guides/ |
| D | unit-tests.rst | 32 …ref:`组件 CMakeLists.txt <component-directories>`，因为他们本身就是一种组件（即测试组件）。ESP-IDF 使用了 Unity 测试框架, 位于 ``u…
84 …signal`` 和 ``unity_send_signal`` 这两个函数来使用 UART 去支持同步操作。如上例中的场景，slave 应该在 master 设置好 GPIO 电平后再去读取 G…
86 DUT1（master）终端::
126 #if !TEMPORARY_DISABLED_FOR_TARGETS(ESP32, ESP8266)
134 #if SOC_SDIO_SLAVE_SUPPORTED
135 #if !TEMPORARY_DISABLED_FOR_TARGETS(ESP64)
149 …禁止的测试项目难以追踪和重新打开。并且，相比于白名单式的 ``#if CONFIG_IDF_TARGET_xxx``，黑名单式的 ``#if !disabled`` 能避免新芯片引入时这些测试被自…
157 …ESP8266 芯片没有 SDIO_PKT_LEN 寄存器。如果在测试过程中需要获取从设备的数据长度，你可以用不同方式读取的 ``#if CONFIG_IDF_TARGET_`` 宏来保护不同的实…
203 (13) "gpio master/slave test example" [ignore][misc][test_env=UT_T2_1][multi_device]
232 Running gpio master/slave test example...
[all …]
|
| /hal_espressif-3.5.0/tools/ci/python_packages/tiny_test_fw/docs/ |
| D | index.rst | 1 .. TinyTestFW documentation master file, created by
10 Usually we send command to the port and then check response to see if the test succeed.
23 if test_fw_path:
50 if __name__ == '__main__':
80 * if you don't pass any arguments, it will use default values
192 * matplotlib (if use Utility.LineChart)
202 * :ref:`genindex`
203 * :ref:`modindex`
204 * :ref:`search`
|
| /hal_espressif-3.5.0/.gitlab/ci/ |
| D | README.md | 5 - [What if Expected Jobs ARE NOT Created?](#what-if-expected-jobs-are-not-created)
13 - [How to Add a New `if` Anchor?](#how-to-add-a-new-if-anchor)
16 - [`if` Anchors Naming Rules](#if-anchors-naming-rules)
28 4. if you push a new commit, a new pipeline will be created automatically.
30 ## What if Expected Jobs ARE NOT Created?
80 - `pattern`: Defined in an array. A GitLab job will be created if the changed files in this MR matc…
87 - `label`: Defined in an if clause, similar as the previous bot command. A GitLab job will be creat…
90 .if-label-build_docs: &if-label-build_docs
91 …if: '$BOT_LABEL_BUILD_DOCS || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*build_docs(?:,[^,\n\r]+…
99 - <<: *if-protected
[all …]
|
| /hal_espressif-3.5.0/docs/en/get-started-legacy/ |
| D | establish-serial-connection.rst | 29 …`ESP32-MeshKit-Sense <https://github.com/espressif/esp-dev-kits/blob/master/esp32-meshkit-sensor/d…
30 …`ESP32-Sense-Kit <https://github.com/espressif/esp-dev-kits/blob/master/esp32-sense-kit/docs/esp32…
34 .. _ESP-Prog: https://github.com/espressif/esp-dev-kits/blob/master/esp-prog/docs/ESP-Prog_guide_en…
116 Then open serial port in terminal and check, if you see any log printed out by ESP32. The log conte…
145 …uding all Espressif boards) *do not* have this issue. The issue is present if RTS & DTR are wired …
151 … got here from section :ref:`get-started-connect-legacy` when installing s/w for ESP32 development…
|
| /hal_espressif-3.5.0/components/esptool_py/esptool/docs/en/esptool/ |
| D | basic-commands.rst | 23 The ``--port`` argument is documented under :ref:`serial-port`.
36 See the :ref:`troubleshooting` section if the ``write_flash`` command is failing, or the flashed mo…
41 You may also need to specify arguments for :ref:`flash mode and flash size <flash-modes>`, if you w…
47 … is to keep the flash mode and size from the ``.bin`` image file. See the :ref:`flash-modes` secti…
67 …Flashing into the bootloader region (``0x0`` -> ``0x8000``) is disabled by default if active `Secu…
70 …den with the ``--force`` option. **Use this only at your own risk and only if you know what you ar…
78 …otloader, application, etc.) without the ``--encrypt`` option is disabled, if `Flash Encryption <h…
82 …ncrypted firmware (bootloader, application, etc.) without the ``--encrypt`` option is disabled, if:
94 … is detected, the ``Chip ID`` and ``Minimum chip revision`` fields in its :ref:`header <image-form…
110 …If ``write_flash`` updated the boot image's :ref:`flash mode and flash size <flash-modes>` during …
[all …]
|
| /hal_espressif-3.5.0/docs/en/api-reference/system/ |
| D | power_management.rst | 24 Power management can be enabled at compile time, using the option :ref:`CONFIG_PM_ENABLE`.
35 …ternatively, if you enable the option :ref:`CONFIG_PM_DFS_INIT_AUTO` in menuconfig, the maximum CP…
39 …dle functionality. If automatic light sleep is requested while the option :ref:`CONFIG_FREERTOS_US…
75 …e switched if dynamic frequency scaling is enabled. You can specify the maximum CPU frequency with…
103 - **UART**: if REF_TICK is used as a clock source. See `use_ref_tick` member of :cpp:class:`uart_co…
104 - **LEDC**: if REF_TICK is used as a clock source. See :cpp:func:`ledc_timer_config` function.
105 - **RMT**: if REF_TICK or XTAL is used as a clock source. See `flags` member of :cpp:class:`rmt_con…
109 - SPI master
122 …ed. However the ``ESP_PM_NO_LIGHT_SLEEP`` lock will still be held, unless :ref:`CONFIG_BTDM_CTRL_L…
|
| /hal_espressif-3.5.0/docs/en/api-guides/ |
| D | lwip.rst | 20 …mponent_file:`lwip/lwip/src/include/lwip/apps/sntp.h` functions (see also :ref:`system-time-sntp-s…
23 …s ``gethostbyname()`` and the convention ``hostname.local``, provided the :ref:`CONFIG_LWIP_DNS_SU…
68 …y calling select internally, so using ``select()`` directly is recommended if a choice of methods …
105 if (sockfd = socket(AF_INET,SOCK_STREAM,0) < 0) {
126 if (select(sockfd + 1, NULL, NULL, &exfds, &tval) <= 0) {
130 if (FD_ISSET(sockfd, &exfds)) {
141 …ease see `newlib errno.h <https://github.com/espressif/newlib-esp32/blob/master/newlib/libc/includ…
183 - ``SO_REUSEADDR`` (available if :ref:`CONFIG_LWIP_SO_REUSE` is set, behavior can be customized by …
187 - ``SO_RCVBUF`` (available if :ref:`CONFIG_LWIP_SO_RCVBUF` is set)
200 - ``IP_PKTINFO`` (available if :ref:`CONFIG_LWIP_NETBUF_RECVINFO` is set)
[all …]
|
| D | unit-tests.rst | 32 …ref:`component CMakeLists.txt <component-directories>`, since they are themselves components (i.e.…
84 …the scenario in the above example, the slave should get GPIO level after master set level. DUT UAR…
86 DUT1 (master) console::
101 …eed to check if reset happens). Sometimes we expect to run some specific tests after certain kinds…
126 #if !TEMPORARY_DISABLED_FOR_TARGETS(ESP32, ESP8266)
134 #if SOC_SDIO_SLAVE_SUPPORTED
135 #if !TEMPORARY_DISABLED_FOR_TARGETS(ESP64)
147 …32`` just to avoid building it on esp32s2, it's hard to make the code tidy if you want to enable t…
149 …if !disabled`` is preferred to white-list style ``#if CONFIG_IDF_TARGET_xxx``, since you will not …
157 …e test process, you can have different implementation code protected by ``#if CONFIG_IDF_TARGET_``…
[all …]
|
| /hal_espressif-3.5.0/docs/en/api-guides/jtag-debugging/ |
| D | configure-ft2232h-jtag.rst | 19 * Verify if {IDF_TARGET_NAME} pins used for JTAG communication are not connected to some other h/w …
59 …OpenOCD. To carry on with debugging environment setup, proceed to section :ref:`jtag-debugging-run…
69 2. Open a terminal, enter ``ls -l /dev/ttyUSB*`` command and check, if board's USB ports are recog…
78 …egation" in `OpenOCD's README <https://sourceforge.net/p/openocd/code/ci/master/tree/README>`_, se…
80 …fective. In terminal enter again ``ls -l /dev/ttyUSB*`` command to verify, if group-owner has chan…
92 …OpenOCD. To carry on with debugging environment setup, proceed to section :ref:`jtag-debugging-run…
142 …just stop OpenOCD and start it again. The driver only needs to be unloaded if |devkit-name| was re…
144 This procedure can be wrapped into a shell script, if desired.
200 To carry on with debugging environment setup, proceed to section :ref:`jtag-debugging-run-openocd`.
|
| /hal_espressif-3.5.0/docs/en/contribute/ |
| D | style-guide.rst | 66 if (condition) { // correct
101 Note however that if someone goes to add new line with a longer identifier as first argument (e.g. …
103 Therefore, use horizontal alignment sparingly, especially if you expect new lines to be added to th…
128 if (condition) {
130 } else if (other_condition) {
161 …#if 0 ... #endif`` blocks. Remove code block completely if it is not used. Otherwise, add comment …
187 …it-id --name-only -r HEAD | xargs dos2unix && git commit -a --amend --no-edit --allow-empty' master
189 (Note that this line rebases on master, change the branch name at the end to rebase on another bran…
238 …When asserting a value of type ``esp_err_t``is equal to ``ESP_OK``, use the :ref:`esp-error-check-…
240 It's possible to configure ESP-IDF projects with assertions disabled (see :ref:`CONFIG_COMPILER_OPT…
[all …]
|
| /hal_espressif-3.5.0/docs/en/get-started/ |
| D | index.rst | 86 …n>`_ (`setup <https://github.com/espressif/vscode-esp-idf-extension/blob/master/docs/tutorial/inst…
152 * :ref:`get-started-get-prerequisites` for :doc:`Windows <windows-setup>`, :doc:`Linux <linux-setup…
153 * :ref:`get-started-get-esp-idf`
154 * :ref:`get-started-set-up-tools`
155 * :ref:`get-started-set-up-env`
160 * :ref:`get-started-start-project`
161 * :ref:`get-started-connect`
162 * :ref:`get-started-configure`
163 * :ref:`get-started-build`
164 * :ref:`get-started-flash`
[all …]
|
| /hal_espressif-3.5.0/docs/en/hw-reference/esp32s2/ |
| D | user-guide-esp32-s2-kaluga-1-kit.rst | 44 …ard combinations have limited compatibility. For more details, please see :ref:`user-guide-esp32-s…
92 …sable all touchpads automatically if multiple pads are simultaneously covered with water and to re…
186 …- In OFF position, GPIO1 to GPIO14 are used for connection to touch sensors; switch to ON if you w…
213 1. Connect the extension board(s) of your choice (go to their respective user guides if necessary)
223 Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` wil…
225 …e found in `esp-dev-kits <https://github.com/espressif/esp-dev-kits/tree/master/esp32-s2-kaluga-1>…
343 …- Do not initialize IO11 (NETWORK) for your ESP-LyraP-TouchA. Also, if you need to use BT_ADC, do …
345 Also, all extension boards and the :ref:`JTAG interface <jtag-debugging-tip-jtag-pins-reconfigured>…
|
| /hal_espressif-3.5.0/docs/en/api-reference/storage/ |
| D | spi_flash.rst | 23 …ref:`CONFIG_SPI_FLASH_USE_LEGACY_IMPL` can be used to switch ``spi_flash_*`` functions back to the…
25 Encrypted reads and writes use the old implementation, even if :ref:`CONFIG_SPI_FLASH_USE_LEGACY_IM…
48 …enuconfig for a board with different Flash and PSRAM, please refer to the :ref:`SPI Flash and Exte…
86 …ing the raw SPI flash functions to the "main" SPI flash chip in favour of :ref:`partition-specific…
201 The lock (see :ref:`spi_bus_lock`) is used to resolve the conflicts among the access of devices on …
209 The delay is used by some long operations which requires the master to wait or polling periodically.
239 In a single core environment (:ref:`CONFIG_FREERTOS_UNICORE` enabled), you need to disable both cac…
|
