From 81ae8d335d89f09d6aa3d454daac4d46f1bb976c Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Sat, 20 Jun 2020 00:54:26 +0800 Subject: [PATCH] docs: fix broken links --- docs/Design.md | 8 ++++---- docs/Getting_started.md | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/Design.md b/docs/Design.md index 5a76ac6..25dff1c 100644 --- a/docs/Design.md +++ b/docs/Design.md @@ -70,9 +70,9 @@ bit 4: BT mode - BR/EDR only mode ``` ### Initialization of slave device -1. Soft reset sdio slave - 1. Host resets sdio part of slave by setting bit 2 of register at 0x3FF5508C - 2. This generates an interrupt for slave device, on which firmware on slave resets its sdio related data structures. +1. Soft reset SDIO slave + 1. Host resets SDIO part of slave by setting bit 2 of register at 0x3FF5508C + 2. This generates an interrupt for slave device, on which firmware on slave resets its SDIO related data structures. 2. Host reads accumulated length and buffer count at slave. 1. Host reads and processes 0x3FF55060 and 0x3FF55044 registers and stores the values in it's data structure 2. These counters are required while performing read and write operation on SDIO interface @@ -90,7 +90,7 @@ bit 4: BT mode - BR/EDR only mode 3. Host then updates it's own counter that keeps track of number of buffers it has transmitted. ### Data transfer from slave to host -1. Whenever slave has data to tranfser, it updates the length in 0x3FF55060 registers and generates an interrupt for host. +1. Whenever slave has data to transfer, it updates the length in 0x3FF55060 registers and generates an interrupt for host. 2. On interruption, host reads interrupt status register [0x3FF55058]. Bit 23 of this register tells host that slave desires to send data. 3. Host then gets the length set by slave by reading register mentioned in step 1. Based on previous received byte count and this length, host understands the actual length of data packet. 4. Host performs read operation to get data from slave diff --git a/docs/Getting_started.md b/docs/Getting_started.md index 950b5cd..43a9757 100644 --- a/docs/Getting_started.md +++ b/docs/Getting_started.md @@ -16,7 +16,7 @@ wifi_ap_scan_list() wifi_connected_stations_list() ``` -These python functions can be used to control Wi-Fi functionality of the ESP32. Also see [host/linux/host_control/host_commands/test.py](../host/linux/host_control/host_commands/test.py) script for an example of using these functions. You can run the script as follows: +These python functions can be used to control Wi-Fi functionality of the ESP32. Also see [host/linux/host_control/test.py](../host/linux/host_control/test.py) script for an example of using these functions. You can run the script as follows: ``` python test.py ``` @@ -67,7 +67,7 @@ python softap_config.py 'xyz' 'xyz123456' 1 3 --max_conn=4 --ssid_hidden=0 --bw= You can check that `ethap0` interface is up (enabled) using `ifconfig`. -To start data connection, set up a DHCP server on the Raspberry Pim, or configure a static IP address for AP interface (`ethap0`). +To start data connection, set up a DHCP server on the Raspberry Pi, or configure a static IP address for AP interface (`ethap0`). 4. `softap_stop.py` is a python script to disable ESP32 softAP mode. This script will change wifi mode to `null` if only softAP is running, or to `station` mode if softAP and station both are on. @@ -102,7 +102,7 @@ TCP Rx: 12 Mbps ## For Bluetooth/BLE functionality -- Ensure that bluez is installed on Raspberry Pi and it is downloaded in source format as well. Please refer [Setup](docs/Setup.md) instructions for more details. +- Ensure that bluez is installed on Raspberry Pi and it is downloaded in source format as well. Please refer to [Setup](Setup.md) instructions for more details. - In following test, Android device was used as a BT/BLE test device. For BLE testing, [nRF connect for mobile APP](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp&hl=en_IN) was used. - Go to `host/linux/host_control/` folder to run following script. -- 2.42.0