From 56b64fd22c8a62f29fd807337601daf36b387051 Mon Sep 17 00:00:00 2001 From: Savelii Pototskii Date: Thu, 25 Jul 2024 06:22:51 +0500 Subject: [PATCH] fix: correct typos in different files (#697) * fix: correct typos in different files --- README.md | 2 +- config/config_en.json | 2 +- docs/hardware/en/lichee/RV/86_panel.md | 4 +- docs/hardware/en/lichee/RV/Dock.md | 4 +- docs/hardware/en/lichee/RV/RV.md | 6 +-- docs/hardware/en/lichee/RV/flash.md | 6 +-- docs/hardware/en/lichee/RV/problems.md | 8 ++-- docs/hardware/en/lichee/RV/ubuntu.md | 4 +- docs/hardware/en/lichee/RV/user.md | 2 +- docs/hardware/en/lichee/RV_Nano/3_images.md | 2 +- docs/hardware/en/lichee/th1520/lm4a.md | 2 +- .../en/lichee/th1520/lpi4a/1_intro.md | 2 +- .../en/lichee/th1520/lpi4a/2_unbox.md | 6 +-- .../en/lichee/th1520/lpi4a/4_burn_image.md | 2 +- docs/hardware/en/maix/m1s/m1s_module.md | 4 +- docs/hardware/en/maix/m1s/other/others.md | 4 +- docs/hardware/en/maix/m1s/other/questions.md | 2 +- docs/hardware/en/maix/m1s/other/start.md | 16 ++++---- .../en/maix/modules_spmod/spmod_bt.md | 4 +- .../en/maix/modules_spmod/spmod_eink.md | 4 +- .../en/maix/modules_spmod/spmod_ethernet.md | 4 +- .../en/maix/modules_spmod/spmod_extender.md | 10 ++--- .../en/maix/modules_spmod/spmod_fpc.md | 6 +-- .../en/maix/modules_spmod/spmod_grove.md | 6 +-- .../en/maix/modules_spmod/spmod_joystick.md | 4 +- .../en/maix/modules_spmod/spmod_lcd1.14.md | 6 +-- .../en/maix/modules_spmod/spmod_lora.md | 4 +- .../en/maix/modules_spmod/spmod_micarray.md | 4 +- .../en/maix/modules_spmod/spmod_psram.md | 6 +-- .../en/maix/modules_spmod/spmod_rfid.md | 4 +- .../en/maix/modules_spmod/spmod_servo.md | 4 +- .../en/maix/modules_spmod/spmod_tof.md | 8 ++-- .../en/maix/modules_spmod/spmod_weather.md | 4 +- docs/hardware/en/maixII/M2/flash.md | 2 +- docs/hardware/en/maixII/M2/other.md | 4 +- docs/hardware/en/maixII/M2/resources.md | 14 +++---- docs/hardware/en/maixII/M2/usage.md | 10 ++--- docs/hardware/en/maixII/M2A/config_system.md | 4 +- docs/hardware/en/maixII/M2A/flash_system.md | 4 +- docs/hardware/en/maixII/M2A/maixsense.md | 6 +-- docs/hardware/en/maixII/M2A/usages.md | 12 +++--- docs/hardware/en/maixIII/ax-pi/axpi.md | 14 +++---- docs/hardware/en/maixIII/ax-pi/dev_prepare.md | 20 +++++----- docs/hardware/en/maixIII/ax-pi/faq_axpi.md | 12 +++--- .../hardware/en/maixIII/ax-pi/flash_system.md | 18 ++++----- .../maixsense-a075v/install_drivers.md | 6 +-- .../maixsense-a075v/maixsense-a075v.md | 4 +- docs/hardware/en/maixzero/sense/start.md | 14 +++---- docs/hardware/en/modules/micarray.md | 6 +-- docs/hardware/en/sidebar.yaml | 4 +- docs/hardware/en/tang/Tang-Nano-1K/Nano-1k.md | 2 +- .../en/tang/Tang-Nano-1K/examples/lcd.md | 2 +- .../Tang-Nano-1K/examples/led/create_led.md | 4 +- docs/hardware/en/tang/Tang-Nano-4K/Nano-4K.md | 4 +- .../en/tang/Tang-Nano-4K/examples/led.md | 2 +- docs/hardware/en/tang/Tang-Nano-9K/Nano-9K.md | 4 +- .../en/tang/Tang-Nano-9K/examples/led.md | 6 +-- .../en/tang/Tang-Nano-9K/examples/picorv.md | 2 +- .../tang/Tang-Nano-9K/examples/rgb_screen.md | 4 +- .../en/tang/Tang-Nano-Doc/flash-in-linux.md | 4 +- .../en/tang/Tang-Nano-Doc/install-the-ide.md | 4 +- .../en/tang/Tang-Nano-Doc/questions.md | 38 +++++++++---------- .../hardware/en/tang/Tang-Nano-Doc/summary.md | 4 +- docs/hardware/en/tang/Tang-Nano/Nano.md | 2 +- .../en/tang/Tang-Nano/examples/lcd.md | 6 +-- .../en/tang/Tang-primer/Tang-primer.md | 2 +- .../Tang-primer/get_started/install_TD_win.md | 4 +- .../Tang-primer/get_started/install_linux.md | 10 ++--- docs/hardware/en/tang/readme.md | 6 +-- .../en/tang/tang-mega-138k/mega-138k.md | 2 +- .../en/tang/tang-nano-20k/example/led.md | 16 ++++---- .../en/tang/tang-nano-20k/nano-20k.md | 2 +- .../en/tang/tang-primer-15k/primer-15k.md | 2 +- .../en/tang/tang-primer-20k/example.md | 2 +- .../en/tang/tang-primer-20k/examples/led.md | 20 +++++----- .../tang-primer-20k/examples/lite/blink.md | 24 ++++++------ .../en/tang/tang-primer-20k/primer-20k.md | 4 +- docs/hardware/zh/tang/Tang-Nano-4K/Nano-4K.md | 2 +- pages/index/en/README.md | 4 +- share_docs/en/change_doc.md | 2 +- 80 files changed, 250 insertions(+), 250 deletions(-) diff --git a/README.md b/README.md index 081f6077..ace70da5 100755 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ teedoc serve More build tool usage see [teedoc](http://github.com/teedoc/teedoc) -## For administator +## For administrator GitHub action will automatically push changed doc to cloud server. But if you did some special things like force commit, some files maybe missing on server, manually trigger the publish_upload_all action to build doc and upload all files to server. diff --git a/config/config_en.json b/config/config_en.json index 6e3592b8..8247eacb 100755 --- a/config/config_en.json +++ b/config/config_en.json @@ -109,7 +109,7 @@ "target": "_blank" }, { - "label": "Open Souece Projects", + "label": "Open Source Projects", "url": "https://github.com/sipeed", "target": "_blank" } diff --git a/docs/hardware/en/lichee/RV/86_panel.md b/docs/hardware/en/lichee/RV/86_panel.md index 82d21de9..4b8a2d90 100644 --- a/docs/hardware/en/lichee/RV/86_panel.md +++ b/docs/hardware/en/lichee/RV/86_panel.md @@ -2,7 +2,7 @@ ## Introduction -Lichee RV-86 Panel is a development kit designed for smart home central control sence. it's equipped with LicheeRV Core board (ALlwinner D1 chip with 512MB ddr3), 4-inch touch IPS screen, Wifi+BT module, Ethernet, two digital silicon mic and GPIO expansion interface. For software it can use Linux OS (Openwrt or Debian) and Ali WATF(WAFT is a high-performance application research framework for aiot based on WebAssembly and their own rendering engine) +Lichee RV-86 Panel is a development kit designed for smart home central control scene. It's equipped with LicheeRV Core board (Allwinner D1 chip with 512MB ddr3), 4-inch touch IPS screen, Wifi+BT module, Ethernet, two digital silicon mic and GPIO expansion interface. For software it can use Linux OS (OpenWrt or Debian) and Ali WAFT (WAFT is a high-performance application research framework for AIoT based on WebAssembly and their own rendering engine) ![Basic board](./../assets/RV/86_2.png) @@ -35,4 +35,4 @@ Lichee RV-86 Panel is a development kit designed for smart home central control ## Support -Email to support@sipeed.com for business cooperation or leave messge in this page for help. \ No newline at end of file +Email to support@sipeed.com for business cooperation or leave message on this page for help. \ No newline at end of file diff --git a/docs/hardware/en/lichee/RV/Dock.md b/docs/hardware/en/lichee/RV/Dock.md index 9b89ead2..0c748d08 100644 --- a/docs/hardware/en/lichee/RV/Dock.md +++ b/docs/hardware/en/lichee/RV/Dock.md @@ -16,7 +16,7 @@ Lichee RV Dock is a RISC-V Linux development kits with high integration, small s | USB | Onboard USB type-A host | | Audio | On-board speaker driver circuit (supports 4Ω 3W speakers) and speaker; connector
On-board electrical microphone circuit | | Memory | Reserved a SOP8 pad, and the connection protocol is the SPI;
Consult for the customer service staff for more information | -| Extra connector | Onborad 30P FPC connector，supports our Mic Array R6 microphone array | +| Extra connector | Onboard 30P FPC connector，supports our Mic Array R6 microphone array | | GPIO connector | Reserved 2x20P 2.54mm pads(Default welding pin headers) | | LED | An onboard WS2812 RGB LED
An onboard power LED | | KEY | An onboard reset key
An user's key | @@ -32,4 +32,4 @@ Lichee RV Dock is a RISC-V Linux development kits with high integration, small s ## Support -Email to support@sipeed.com for business cooperation or leave messge in this page for help. +Email to support@sipeed.com for business cooperation or leave message on this page for help. diff --git a/docs/hardware/en/lichee/RV/RV.md b/docs/hardware/en/lichee/RV/RV.md index 7dd1a077..1b03577c 100644 --- a/docs/hardware/en/lichee/RV/RV.md +++ b/docs/hardware/en/lichee/RV/RV.md @@ -3,7 +3,7 @@ > Edit on 2022.05.13 ## Overview -Lichee RV - Nezha CM is a compute module with modular design, equipped with Allwinner D1 chip (based on T-Head XuanTie C906 core), 512MB DDR3 RAM. It can boot from TF card or SD-NAND, uses two sets of M.2 b key 67 pin connectors to route all IO, making it convient for wide use and easy to replace. +Lichee RV - Nezha CM is a compute module with modular design, equipped with Allwinner D1 chip (based on T-Head XuanTie C906 core), 512MB DDR3 RAM. It can boot from TF card or SD-NAND, uses two sets of M.2 b key 67 pin connectors to route all IO, making it convenient for wide use and easy to replace. ![](./../assets/RV/D1-4.jpg) @@ -15,7 +15,7 @@ Lichee RV - Nezha CM is a compute module with modular design, equipped with Allw | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | CPU | Allwinner D1 chip (Based on T-Head XuanTie C906 core) up to 1GHZ | | RAM | 16bits 512MB DDR3，Up to 792MHz | -| Storge | Onboard TF card slot，can use tf card for storing,1TB storage capacity have been tested ok
Reserve SD-NAND pads (Conflict with 8pins lcd interface. using for business custom made ) | +| Storage | Onboard TF card slot，can use tf card for storing,1TB storage capacity have been tested ok
Reserve SD-NAND pads (Conflict with 8pins lcd interface. using for business custom made ) | | Display | **MIPI**：4-lane MIPI DSI
**RGB**：RGB888 interface(partially multiplexed with DSI)
**MCU** : I80 interface
**SPI**：Onboard 8pins SPI screen interface，can be used for 1.14 inch screen | | Audio | Analog audio headphone output(HPOUT);
Analog audio line input(LINEIN);
Digital Audio (I2S/SPDIF);
Analog microphone interface(MIC3);
Digital microphone interface(DMIC);
All above pin out to connecting finger | | Ethernet | Pin out RMII/RGMII to connecting finger (Multiplexed with some GPIOs) | @@ -25,7 +25,7 @@ Lichee RV - Nezha CM is a compute module with modular design, equipped with Allw | Led | • A power led
• A user led (active high) | | PCB | 4 layers | | Fixed
way | Connect the core board and bottom board by two sets of M.2B connecting finger and fasten with a M2 screw | -| Development lanuguge | C/C++, Python, Golang, etc... | +| Development language | C/C++, Python, Golang, etc... | | System Mirrors | Tina Linux (Based on OpenWRT 14.07), Debian, YoC (RTOS ) | ![](./../assets/RV/D1-pin.png) diff --git a/docs/hardware/en/lichee/RV/flash.md b/docs/hardware/en/lichee/RV/flash.md index ba9e6fb3..233f0bb6 100644 --- a/docs/hardware/en/lichee/RV/flash.md +++ b/docs/hardware/en/lichee/RV/flash.md @@ -6,7 +6,7 @@ There are two system images for Lichee RV and they are tina and debian. ## Prepare 1. Lichee RV Core board -2. TF card (It's suggested to use tf card provided by sipeed beacuse other card might fail to burn or fail to boot system) +2. TF card (It's suggested to use tf card provided by sipeed because other card might fail to burn or fail to boot system) 3. Burn tool [PhoenixCard](https://dl.sipeed.com/shareURL/LICHEE/D1/Lichee_RV/tool) 4. System image - [Tina](https://dl.sipeed.com/shareURL/LICHEE/D1/Lichee_RV/SDK/image) @@ -45,12 +45,12 @@ Follow the steps below to complete burning - From `Status bar` marked with ④ to see your progress；If it's red when finishing this means it fails burning, then we should rerun `SD Card Formatter` to format the TF card to increase its success possibility. - Click `Close` to close PhoenixCard -> Not each card can successed be burned, if you can't do this we suggest you buy an image card we provide +> Not each card can successfully be burned, if you can't do this we suggest you buy an image card we provide Waiting for finishing burning, It will be faster if flashing Tina OS and it will take about 10 minutes if flashing Debian ## Run OS -The username and passward are as follows: +The username and password are as follows: - Tina OS username：`root` password：`tina` diff --git a/docs/hardware/en/lichee/RV/problems.md b/docs/hardware/en/lichee/RV/problems.md index a1fc2ec0..48d1541b 100644 --- a/docs/hardware/en/lichee/RV/problems.md +++ b/docs/hardware/en/lichee/RV/problems.md @@ -1,6 +1,6 @@ --- title: Questions&Answers -keywords: debian, Rv, Problam, apt, img, sipeed +keywords: debian, Rv, Problem, apt, img, sipeed --- ## Apt trouble @@ -11,7 +11,7 @@ keywords: debian, Rv, Problam, apt, img, sipeed This means built-in key expires and need updating manually, here are two ways to download key. - - Doanload from web page：https://packages.debian.org/sid/all/debian-ports-archive-keyring/download + - Download from web page：https://packages.debian.org/sid/all/debian-ports-archive-keyring/download - wget : `wget http://ftp.cn.debian.org/debian/pool/main/d/debian-ports-archive-keyring/debian-ports-archive-keyring_2022.02.15_all.deb` Copy downloaded key (usr scp or lrzsz tool) into LicheeRV board, then run following command to update key: @@ -22,7 +22,7 @@ Then run `sudo apt-get update` to update apt. ## Not work -- Make sure you choose as what is shown below when burnning card by yourself +- Make sure you choose as what is shown below when burning card by yourself
Click to see burn requirement @@ -35,7 +35,7 @@ Then run `sudo apt-get update` to update apt. ## 86 panel screen no display/ display wrong -Here we need use corresopnding fex file to overwrite the board-level configuration by using following command in linux system +Here we need use corresponding fex file to overwrite the board-level configuration by using following command in linux system Download fex file here https://dl.sipeed.com/shareURL/LICHEE/D1/Lichee_RV/SDK/board Overwrite command: ```bash diff --git a/docs/hardware/en/lichee/RV/ubuntu.md b/docs/hardware/en/lichee/RV/ubuntu.md index b95f9cab..17a71dc5 100644 --- a/docs/hardware/en/lichee/RV/ubuntu.md +++ b/docs/hardware/en/lichee/RV/ubuntu.md @@ -41,7 +41,7 @@ Visit [balenaEtcher](https://www.balena.io/etcher/) to download application. We ### Flash System -Prepare a SD card over 8G, the card with better performance can have better experienxe. +Prepare a SD card over 8G, the card with better performance can have better experience. Connect the TF card with computer by SD card reader or SD card slot in the computer. Here is an example about SD card slot in computer, if your computer dose not have SD card slot, you need the SD card reader. @@ -74,7 +74,7 @@ This will take a bit time, and after finishing this work it will be like as foll ## Run System -Finishing flashing system and seeing `sucessful` shown in the end, we can connect SD card with this board to start ubuntu. +Finishing flashing system and seeing `successful` shown in the end, we can connect SD card with this board to start ubuntu. ![dock_pro_ubuntu](./../../../zh/lichee/assets/RV/ubuntu/dock_pro_ubuntu.jpg) diff --git a/docs/hardware/en/lichee/RV/user.md b/docs/hardware/en/lichee/RV/user.md index 67d2efcc..02dd7527 100644 --- a/docs/hardware/en/lichee/RV/user.md +++ b/docs/hardware/en/lichee/RV/user.md @@ -16,7 +16,7 @@ It may run slow because of the speed of TF card. The users name is `root` and password is `licheepi` -**When using serial port connets board it always print kernel message, do following steps to stop it:** +**When using serial port connection board it always print kernel message, do following steps to stop it:** - Edit `/etc/rsyslog.conf` by root and change `*.emerg` located in lht last line into `#*.emerg` in this file - Restart rsyslog service by this command `/etc/init.d/rsyslog restart` diff --git a/docs/hardware/en/lichee/RV_Nano/3_images.md b/docs/hardware/en/lichee/RV_Nano/3_images.md index 0c9541d4..3cd1d03d 100644 --- a/docs/hardware/en/lichee/RV_Nano/3_images.md +++ b/docs/hardware/en/lichee/RV_Nano/3_images.md @@ -12,4 +12,4 @@ The image is compressed using xz. After decompression, use tools like Rufus, Win ## Debian Sid Based image -[Image Infomation and Downloads](https://github.com/Fishwaldo/sophgo-sg200x-debian) +[Image Information and Downloads](https://github.com/Fishwaldo/sophgo-sg200x-debian) diff --git a/docs/hardware/en/lichee/th1520/lm4a.md b/docs/hardware/en/lichee/th1520/lm4a.md index 43c8b65d..6315f6c7 100644 --- a/docs/hardware/en/lichee/th1520/lm4a.md +++ b/docs/hardware/en/lichee/th1520/lm4a.md @@ -36,7 +36,7 @@ The LicheePi 4A Module is the Core Module using the [T-Head](https://www.t-head. NPU - Support 4TOPS@INT8, up to 1GHz
· Support TensorFlow、ONNX、Caffe
· Support CNN、RNN、DNN + Support 4TOPS@INT8, up to 1GHz
· Support TensorFlow, ONNX, Caffe
· Support CNN, RNN, DNN Decode diff --git a/docs/hardware/en/lichee/th1520/lpi4a/1_intro.md b/docs/hardware/en/lichee/th1520/lpi4a/1_intro.md index 3f2eef9c..8d856039 100644 --- a/docs/hardware/en/lichee/th1520/lpi4a/1_intro.md +++ b/docs/hardware/en/lichee/th1520/lpi4a/1_intro.md @@ -81,7 +81,7 @@ For quality contributions to the docs, we offer discount coupons from ¥5 to ¥1 Storage - · eMMC(Optional): None 、 8G、 32G、 128G
· Support TF card + · eMMC(Optional): None, 8G, 32G, 128G
· Support TF card Ethernet diff --git a/docs/hardware/en/lichee/th1520/lpi4a/2_unbox.md b/docs/hardware/en/lichee/th1520/lpi4a/2_unbox.md index be9926db..5bccd4d3 100644 --- a/docs/hardware/en/lichee/th1520/lpi4a/2_unbox.md +++ b/docs/hardware/en/lichee/th1520/lpi4a/2_unbox.md @@ -121,7 +121,7 @@ LicheePi 4A is a high performance SBC，you need to install an active cooler to ![silicone_pad](./../../../../zh/lichee/th1520/lpi4a/assets/unbox/silicone_pad.png) 2. Installing the fan / heatsink - Allign the 30x30mm heatsink and fan with the thermal pad and press down lightly. + Align the 30x30mm heatsink and fan with the thermal pad and press down lightly. ![insert_fan](./../../../../zh/lichee/th1520/lpi4a/assets/unbox/insert_fan.png) 3. Connecting the cooling fan @@ -161,7 +161,7 @@ LicheePi 4A is pre-loaded with a basic system image, so you can try it out direc Note: The pre-loaded system image might be very old. After you booted the system for the first time, please have a look at the next section on how to flash / update the image. Use an HDMI cable (not included) to connect a display (not included) to the HDMI port of LicheePi 4A. Use the supplied USB-C cable to connect the board to a USB power supply (not included) with at least 5V and 2A output. -The LicheePi 4A will automatically boot into the default image and the login screen should appear within 30 seconds, or automaticly login via sipeed username. +The LicheePi 4A will automatically boot into the default image and the login screen should appear within 30 seconds, or automatically login via sipeed username. ![boot_login](./../../../../zh/lichee/th1520/lpi4a/assets/unbox/boot_login.png) @@ -255,7 +255,7 @@ After booting up the board for the first time, let´s take a look at the hardwar The nominal operating frequency of the TH1520 is 1.85GHz, and we only guarantee that the board you receive can work stably at 1.85GHz. If you are an enthusiast you can try to overclock the board to 2GHz, but we don´t guarantee that the board will work stable at this frequency. -After some testing, about 80% of the boards can boot into the system when overclocked to 2GHz and about 50% of the boards sucessfully pass the stress test at 2GHz. +After some testing, about 80% of the boards can boot into the system when overclocked to 2GHz and about 50% of the boards successfully pass the stress test at 2GHz. ### USB Power Limitation diff --git a/docs/hardware/en/lichee/th1520/lpi4a/4_burn_image.md b/docs/hardware/en/lichee/th1520/lpi4a/4_burn_image.md index 8c58bd33..61c50054 100644 --- a/docs/hardware/en/lichee/th1520/lpi4a/4_burn_image.md +++ b/docs/hardware/en/lichee/th1520/lpi4a/4_burn_image.md @@ -23,7 +23,7 @@ The following burning method takes Debian single-screen image `LPI4A_20230721.zi ### Get the burning tool The burning tool can be obtained from the Mega cloud disk and is found in the `burn_tool.zip` file. -After decompresseion the fastboot binary is found in the win/linux/mac subfolders. +After decompression the fastboot binary is found in the win/linux/mac subfolders. **Note:** Images from 20231023 and later versions have added support for burning large image files, which require using the latest version of fastboot. You can find the latest version of fastboot in the [cloud disk link](https://mega.nz/folder/phoQlBTZ#cZeQ3qZ__pDvP94PT3_bGA). The file name is `burn_tools_support_bigimage.zip`. ## How to enter burning mode diff --git a/docs/hardware/en/maix/m1s/m1s_module.md b/docs/hardware/en/maix/m1s/m1s_module.md index e515a3a6..16af0546 100644 --- a/docs/hardware/en/maix/m1s/m1s_module.md +++ b/docs/hardware/en/maix/m1s/m1s_module.md @@ -299,7 +299,7 @@ Visit Schematic for details：[Click me](https://dl.sipeed.com/shareURL/MAIX/M1s Pooling MaxPool (NPU TBD) - Kerenl: 2x2 + Kernel: 2x2 DSP @@ -307,7 +307,7 @@ Visit Schematic for details：[Click me](https://dl.sipeed.com/shareURL/MAIX/M1s MaxPool - Kerenl: 3x3 + Kernel: 3x3 :strong:NPU diff --git a/docs/hardware/en/maix/m1s/other/others.md b/docs/hardware/en/maix/m1s/other/others.md index f1d1ae82..19f5a588 100644 --- a/docs/hardware/en/maix/m1s/other/others.md +++ b/docs/hardware/en/maix/m1s/other/others.md @@ -86,7 +86,7 @@ The camera can be assembled in two directions: the camera shooting direction is Rotate the shell to make the TF card slot on the board is in the same direction as the SiPEED logo on the shell Align the two TypeC ports with the holes in the shell to prepare for inserting the board into the shell - Press where the arrow points at, it's a bit difficult for first time inserting, make sure the two TypeC ports align with the holes. Inster board into the shell + Press where the arrow points at, it's a bit difficult for first time inserting, make sure the two TypeC ports align with the holes. Insert board into the shell insert_screen_direction_1 @@ -136,7 +136,7 @@ Up to now we have finished installing shell. - + diff --git a/docs/hardware/en/maix/m1s/other/questions.md b/docs/hardware/en/maix/m1s/other/questions.md index a8beaa73..db9887b5 100644 --- a/docs/hardware/en/maix/m1s/other/questions.md +++ b/docs/hardware/en/maix/m1s/other/questions.md @@ -11,5 +11,5 @@ update: ## c906_app/build_out/xxxxx/.map:No such file or directory -When compiling your firmware, make sure your command is `./build.sh demo_name`, like `./build.sh hello_world`, not `./build.sh hello_world/` (pay atention to the end symbol `/`) +When compiling your firmware, make sure your command is `./build.sh demo_name`, like `./build.sh hello_world`, not `./build.sh hello_world/` (pay attention to the end symbol `/`) diff --git a/docs/hardware/en/maix/m1s/other/start.md b/docs/hardware/en/maix/m1s/other/start.md index 55defa3c..31f6bf13 100644 --- a/docs/hardware/en/maix/m1s/other/start.md +++ b/docs/hardware/en/maix/m1s/other/start.md @@ -178,7 +178,7 @@ We mainly use `BLDevCube`, `BLDevCube-macos` and `BLDevCube-ubuntu` these three ![application](./../../../../zh/maix/m1s/other/assets/start/application.png) -And there are `bflb_iot_tool`、`bflb_iot_tool-macos`、`bflb_iot_tool-ubuntu` three applications, with which we can burn this board via commad line. +And there are `bflb_iot_tool`、`bflb_iot_tool-macos`、`bflb_iot_tool-ubuntu` three applications, with which we can burn this board via command line. #### Burn via graphical interface @@ -201,9 +201,9 @@ The firmware file for E907 or C906 can be gotten by compiling [M1s_dock example] First time burning, both `firmware` and `boot2` are needed, after this you just need tick what you want to burn not all. -The default old firmware can be downloaded [here](https://dl.sipeed.com/shareURL/MAIX/M1s/M1s_Dock/7_Firmware/factory), and the newest firmware is not frovided any more. [Click me](https://wiki.sipeed.com/hardware/en/maix/m1s/other/start.html#Old-firmware-test) to see the old factory firmware details. +The default old firmware can be downloaded [here](https://dl.sipeed.com/shareURL/MAIX/M1s/M1s_Dock/7_Firmware/factory), and the newest firmware is not provided any more. [Click me](https://wiki.sipeed.com/hardware/en/maix/m1s/other/start.html#Old-firmware-test) to see the old factory firmware details. -After choose the firmware, click the `Refresh` in the righr to refresh the serial port, then we can see 2 serial ports. If there are not 2 serial ports, visit [Burn onboard bl702](https://wiki.sipeed.com/hardware/en/maix/m1s/other/start.html#Burn-onboard-bl702) to solve this. We choose the bigger number serial port, and set uartrate 2000000 . +After choose the firmware, click the `Refresh` in the righr to refresh the serial port, then we can see 2 serial ports. If there are not 2 serial ports, visit [Burn onboard bl702](https://wiki.sipeed.com/hardware/en/maix/m1s/other/start.html#Burn-onboard-bl702) to solve this. We choose the bigger number serial port, and set uart rate 2000000 . ![burn_steps](./../../../../zh/maix/m1s/other/assets/start/burn_steps.png) @@ -242,7 +242,7 @@ Of course, make sure you have made this board into UART burning mode: Press BOOT ![command_burn_flash](./../../../../zh/maix/m1s/other/assets/start/command_burn_flash.jpg) -After burning these, you can burn the bin file for C906 core according to [Burn via u-disk](https://wiki.sipeed.com/hardware/en/maix/m1s/other/start.html#Burn-via-u-disk). You can also burn this board based on the adderss, from `partition_cfg_16M_m1sdock.toml` file you can know the burn address and modify it. +After burning these, you can burn the bin file for C906 core according to [Burn via u-disk](https://wiki.sipeed.com/hardware/en/maix/m1s/other/start.html#Burn-via-u-disk). You can also burn this board based on the address, from `partition_cfg_16M_m1sdock.toml` file you can know the burn address and modify it. ### Troubles when burning @@ -353,7 +353,7 @@ M1s can be compiled in Linux. ### Preparation -We need `git` to get the SDK complie envorioument, and use `make` to compile SDK, `tree` is also need to be installed to check the directory structure. +We need `git` to get the SDK compile environment, and use `make` to compile SDK, `tree` is also need to be installed to check the directory structure. The following command can be used in debian Linux distribution like Ubuntu to install the three softwares mentioned above. @@ -435,7 +435,7 @@ sipeed@DESKTOP:~$ tree -L 2 ### Set toolchain path -Everytime compling for M1s, we need to set toolchain path once. +Every time compiling for M1s, we need to set toolchain path once. First we need to know the path of `M1s_BL808_SDK`: @@ -445,7 +445,7 @@ sipeed@DESKTOP:~/M1s_BL808_SDK$ pwd /home/lee/bl808/M1s_BL808_SDK ``` -We copy the result (the result of everyone is different) of `pwd` command, then run following commamd to set toolchain path. +We copy the result (the result of everyone is different) of `pwd` command, then run following command to set toolchain path. ```bash export BL_SDK_PATH=/home/lee/bl808/M1s_BL808_SDK @@ -506,7 +506,7 @@ Then the compiled bin file is in M1s_BL808_example/e907_app/build_out folder, an 2. Failed compiling -When compiling your firmware, make sure your command is `./build.sh demo_name`, like `./build.sh hello_world`, not `./build.sh hello_world/` (pay atention to the end symbol `/`) +When compiling your firmware, make sure your command is `./build.sh demo_name`, like `./build.sh hello_world`, not `./build.sh hello_world/` (pay attention to the end symbol `/`) ## WIFI stream DEMO diff --git a/docs/hardware/en/maix/modules_spmod/spmod_bt.md b/docs/hardware/en/maix/modules_spmod/spmod_bt.md index a9e7a763..4984b213 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_bt.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_bt.md @@ -175,5 +175,5 @@ SPMOD-BT(Bluetooth module) uses YDJ-23. | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file diff --git a/docs/hardware/en/maix/modules_spmod/spmod_eink.md b/docs/hardware/en/maix/modules_spmod/spmod_eink.md index d2bbb867..3bd524c2 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_eink.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_eink.md @@ -229,7 +229,7 @@ The following parameters need to be modified | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telgram link | [https://t.me/sipeed](https://t.me/sipeed) | diff --git a/docs/hardware/en/maix/modules_spmod/spmod_ethernet.md b/docs/hardware/en/maix/modules_spmod/spmod_ethernet.md index 50fb0e1b..476bcc25 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_ethernet.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_ethernet.md @@ -75,5 +75,5 @@ SPMOD_Ethernet(Ethernet module) uses W5500 chip. | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| telegram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file diff --git a/docs/hardware/en/maix/modules_spmod/spmod_extender.md b/docs/hardware/en/maix/modules_spmod/spmod_extender.md index 04e192e3..2853e0e3 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_extender.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_extender.md @@ -18,9 +18,9 @@ SPMOD_Extender(8PIN SP-MOD Expander) | Features: | --- | | --- | -- | -| Two-wire SP-MOD interface*3 | Connect to the D0 and D1 on the SP-MOD，Used as UART interface (Connect at most one device) -or I2C interface(Connect at most three device) , can also be used as two independent GPIO | -| Four-wire SP-MOD interface | Connect to the D2-D5 on the SP-MOD，Uusually used as SPI interface， +| Two-wire SP-MOD interface*3 | Connect to the D0 and D1 on the SP-MOD, Used as UART interface (Connect at most one device) +or I2C interface(Connect at most three device), can also be used as two independent GPIO | +| Four-wire SP-MOD interface | Connect to the D2-D5 on the SP-MOD, Usually used as SPI interface, can also be used as four independent GPIO | | Supply voltage of external power supply | Depends on connected modules | | Supply current of external power supply | Depends on the working conditions of the module, usually less than 1000mA | @@ -46,5 +46,5 @@ can also be used as four independent GPIO | | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file diff --git a/docs/hardware/en/maix/modules_spmod/spmod_fpc.md b/docs/hardware/en/maix/modules_spmod/spmod_fpc.md index 191ff2f7..92f73774 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_fpc.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_fpc.md @@ -10,7 +10,7 @@ SPMOD_FPC( SPMOD extension module ) ## SPMOD - FPC Introduction -- Using **Sipeed-SPMOD** interface(2.54mm * 8PIN )，unified MaixPy board interface +- Using **Sipeed-SPMOD** interface(2.54mm * 8PIN ), unified MaixPy board interface - As an extension module, easily extend the SP-MOD interface with FPC. - Provide a pair of SP-MOD to FPC adapters(Male and female), one FPC cable(10P). - Size:15.0\*10.0\*3.3mm @@ -45,5 +45,5 @@ SPMOD_FPC( SPMOD extension module ) | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file diff --git a/docs/hardware/en/maix/modules_spmod/spmod_grove.md b/docs/hardware/en/maix/modules_spmod/spmod_grove.md index 2f73cc1c..77764fe0 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_grove.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_grove.md @@ -11,7 +11,7 @@ SPMOD_Grove(GROVE module) ## SPMOD - Grove Introduction - Using **Sipeed-SPMOD** interface(2.54mm * 8PIN )，unified MaixPy board interface -- Ass an Expansion board，it povides three standard Grove interfaces. +- Ass an Expansion board, it povides three standard Grove interfaces. - All data cables are provide external pull-ups. - The power supply can handle up to 1000mA - Size:35.0\*10.0\*2.1mm @@ -45,5 +45,5 @@ SPMOD_Grove(GROVE module) | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file diff --git a/docs/hardware/en/maix/modules_spmod/spmod_joystick.md b/docs/hardware/en/maix/modules_spmod/spmod_joystick.md index 957d543e..ea5b9dd4 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_joystick.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_joystick.md @@ -56,5 +56,5 @@ SPMOD_JoyStick (JoyStick module). | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file diff --git a/docs/hardware/en/maix/modules_spmod/spmod_lcd1.14.md b/docs/hardware/en/maix/modules_spmod/spmod_lcd1.14.md index 6fa47836..e2c383fd 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_lcd1.14.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_lcd1.14.md @@ -10,7 +10,7 @@ SPMOD_LCD1.14(1.14 inch LCD) uses ST7735S TFT LCD. ## SPMOD - LCD1.14 Introduction - Using **Sipeed-SPMOD** interface(2.54mm * 8PIN )，unified MaixPy board interface -- Using commom LCD driver IC ST7735S(4-wire SPI communicate) +- Using common LCD driver IC ST7735S(4-wire SPI communicate) - Display Resolution:240\*135 - Size:35.0\*20.0mm @@ -214,5 +214,5 @@ The following parameters need to be modified. | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file diff --git a/docs/hardware/en/maix/modules_spmod/spmod_lora.md b/docs/hardware/en/maix/modules_spmod/spmod_lora.md index 79edcd1d..8c317711 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_lora.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_lora.md @@ -208,5 +208,5 @@ The following parameters need to be modified | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file diff --git a/docs/hardware/en/maix/modules_spmod/spmod_micarray.md b/docs/hardware/en/maix/modules_spmod/spmod_micarray.md index 7cb20f7c..ace7592d 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_micarray.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_micarray.md @@ -69,5 +69,5 @@ Thermal Shutdown,Integrated 80mΩ Power MOSFET | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file diff --git a/docs/hardware/en/maix/modules_spmod/spmod_psram.md b/docs/hardware/en/maix/modules_spmod/spmod_psram.md index e92a57e5..29274c82 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_psram.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_psram.md @@ -32,7 +32,7 @@ SPMOD_PSRAM(PSRAM module) uses IPS6404L-SQ PSRAM. ### SPMOD_PSRAM pin description: -| Pin | Name | Type | Decription | +| Pin | Name | Type | Description | | -------- | -------- | ---- | ---------- | | 1 | GND | G | Ground | | 2 | CS | I | Chip Select input pin | @@ -70,5 +70,5 @@ SPMOD_PSRAM(PSRAM module) uses IPS6404L-SQ PSRAM. | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | diff --git a/docs/hardware/en/maix/modules_spmod/spmod_rfid.md b/docs/hardware/en/maix/modules_spmod/spmod_rfid.md index 72c8af8c..9e963f23 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_rfid.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_rfid.md @@ -198,5 +198,5 @@ The following parameters need to be modified | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | diff --git a/docs/hardware/en/maix/modules_spmod/spmod_servo.md b/docs/hardware/en/maix/modules_spmod/spmod_servo.md index 5c8a79e3..baa3b8ef 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_servo.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_servo.md @@ -53,5 +53,5 @@ SPMOD_SERVO (SERVO module). | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | \ No newline at end of file diff --git a/docs/hardware/en/maix/modules_spmod/spmod_tof.md b/docs/hardware/en/maix/modules_spmod/spmod_tof.md index 1cf3014f..31f50959 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_tof.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_tof.md @@ -65,7 +65,7 @@ SPMOD_TOF(TOF module) uses VL53L0X . * Process - 1. Initializatin + 1. Initialization 2. Adjust(option) 3. Get distance @@ -143,7 +143,7 @@ Modify the following parameters to fit other K210 boards. ```c // board_config.h #define VL53L0X_I2C_DEVICE 0 // i2c device number - #define VL53L0X_I2C_FREQ_KHZ 100 // i2c frequence + #define VL53L0X_I2C_FREQ_KHZ 100 // i2c frequency #define VL53L0X_SCL 6 // scl #define VL53L0X_SDA 7 // sda #define VL53L0X_SHT 8 // sht @@ -181,5 +181,5 @@ Modify the following parameters to fit other K210 boards. | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | diff --git a/docs/hardware/en/maix/modules_spmod/spmod_weather.md b/docs/hardware/en/maix/modules_spmod/spmod_weather.md index bcbabbeb..319ae624 100644 --- a/docs/hardware/en/maix/modules_spmod/spmod_weather.md +++ b/docs/hardware/en/maix/modules_spmod/spmod_weather.md @@ -150,5 +150,5 @@ low power consumption (75uA). | Sipeed model shop | [https://maixhub.com/](https://maixhub.com/) | | SDK Relevant information | [dl.sipeed.com/MAIX/SDK](dl.sipeed.com/MAIX/SDK) | | HDK Relevant information | [dl.sipeed.com/MAIX/HDK](dl.sipeed.com/MAIX/HDK) | -| E-mail(Technical Support and Business Cooperation) | [Support@sipeed.com](mailto:support@sipeed.com) | -| telgram link | [https://t.me/sipeed](https://t.me/sipeed) | +| E-mail(Technical Support and Business Cooperation) | [support@sipeed.com](mailto:support@sipeed.com) | +| Telegram link | [https://t.me/sipeed](https://t.me/sipeed) | diff --git a/docs/hardware/en/maixII/M2/flash.md b/docs/hardware/en/maixII/M2/flash.md index 562ae8d3..7c7f2106 100644 --- a/docs/hardware/en/maixII/M2/flash.md +++ b/docs/hardware/en/maixII/M2/flash.md @@ -35,7 +35,7 @@ Only bussiness edition M2 model contains the Flash, so we need to start the syst ### Preparation -- Get burnning tool [PhoenixCard](https://dl.sipeed.com/shareURL/MaixII/MaixII-Dock/SDK/tools) +- Get burning tool [PhoenixCard](https://dl.sipeed.com/shareURL/MaixII/MaixII-Dock/SDK/tools) - Get [image file](https://dl.sipeed.com/shareURL/MaixII/MaixII-Dock/SDK/release) - Get SD card Formatter Tool [SD Card Formatter](https://www.sdcard.org/downloads/formatter/eula_windows/SDCardFormatterv5_WinEN.zip) diff --git a/docs/hardware/en/maixII/M2/other.md b/docs/hardware/en/maixII/M2/other.md index 5af04d0f..362a62d5 100644 --- a/docs/hardware/en/maixII/M2/other.md +++ b/docs/hardware/en/maixII/M2/other.md @@ -66,7 +66,7 @@ The rule of dtb file name is shown as following: | sipeed_1.3_240x240_vs3205.dtb | 1.3 inch | vs3205 | | sipeed_1.3_240x240_sp2305.dtb | 1.3 inch | sp2305 | -Copy the compiled dtb file into the virtual U-disk, then run following commmand in adb shell. +Copy the compiled dtb file into the virtual U-disk, then run following command in adb shell. ```bash sync #Refresh contents @@ -76,7 +76,7 @@ reboot #Restart to apply Then we succeed changing device tree. -- If your screen displays incorrectly, this means you choose wrond dtb file, just reupdate it to fix this. +- If your screen displays incorrectly, this means you choose wrong dtb file, just reupdate it to fix this. Here is a correct display picture. diff --git a/docs/hardware/en/maixII/M2/resources.md b/docs/hardware/en/maixII/M2/resources.md index 770c2246..94eee0f1 100644 --- a/docs/hardware/en/maixII/M2/resources.md +++ b/docs/hardware/en/maixII/M2/resources.md @@ -4,10 +4,10 @@ keywords: MaixII, MaixPy3, Python, Python3, M2dock desc: maixpy Onboard resources --- -Maix-II-Dock is positioned as a cost-effective AIOT development board. While supporting conventional Linux development, it also has a unique AI hardware acceleration feature. With the complete software ecosystem provided by Sipeed, you can quickly realize your edge AI application. +Maix-II-Dock is positioned as a cost-effective AIoT development board. While supporting conventional Linux development, it also has a unique AI hardware acceleration feature. With the complete software ecosystem provided by Sipeed, you can quickly realize your edge AI application. * **Hardware**, based on the Allwinner V831 chip, the development board is formed in the form of [core board] + [ext-board]. You can use the development board directly, or you can use only the core board to design your own ext-board according to your needs, which is convenient and fast to complete the development. -* **Software**, in addition to directly using the datasheet provided by Allwinner for development (some satasheet may need to be obtained from Allwinner), Sipeed provides a very convenient Python SDK ([MaixPy3](/maixpy3)) and C SDK ([libmaix](https://github.com/sipeed/libmaix)). It also provides an online model training service ([MaixHub](https://maixhub.com), which is more convenient for beginners to quickly train their usable AI models. +* **Software**, in addition to directly using the datasheet provided by Allwinner for development (some datasheet may need to be obtained from Allwinner), Sipeed provides a very convenient Python SDK ([MaixPy3](/maixpy3)) and C SDK ([libmaix](https://github.com/sipeed/libmaix)). It also provides an online model training service ([MaixHub](https://maixhub.com), which is more convenient for beginners to quickly train their usable AI models. * **Purchase**: [sipeed.aliexpress.com](https://www.aliexpress.com/item/1005002538932487.html)

@@ -67,14 +67,14 @@ Normally we think the screen panel is the front and camera is back. | Number | Maix II Part | Function | Note | | ------ | ---------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------- | -| 1 | M.2 B-KEY female slot*1 | Used for connect V831 core board | Have connectted with core board when sold | +| 1 | M.2 B-KEY female slot*1 | Used for connect V831 core board | Have connected with core board when sold | | 2 | Core board M2 copper column nuts*1 | Fix core board with bottom board | Have been fixed when sold | | 3 | Power LED*1 | Show power state | --- | | 4 | State LED*1 | User programmable led | --- | | 5 | CPU Reset button*1 | Reset V831 chip | --- | -| 6 | User button*2 | Change IO voltage value，custome usage | --- | +| 6 | User button*2 | Change IO voltage value，custom usage | --- | | 7 | Wi-Fi module*1 | RTL8189FTV，adds Wi-Fi function for this board | SDIO Interface | -| 8 | BTB camera interface*1 | Connect BTB camera module | Have connectted with bottom board when sold | +| 8 | BTB camera interface*1 | Connect BTB camera module | Have connected with bottom board when sold | | 9 | Camera M2 copper column nuts*2 | Fix BTB camera with bottom board | Have been fixed when sold | | 10 | FHD camera*1 | Default SP2305 Sensor BTB style, 1080P | Default 6mm focal length M12 lens，can use other Suitable camera | | 11 | USB to UART chip*1 | Provide serial port communication | --- | @@ -83,11 +83,11 @@ Normally we think the screen panel is the front and camera is back. | 14 | Three-axis accelerometer*1 | I2C interface，can read 3 axes acceleration data | --- | | 15 | MicroSD card slot*1 | Connect microSD card | Default boot from SD card | | 16 | LCD interface*1 | FPC0.5mm 24Pin，MCU interface | | -| 17 | IPS HD screen\*1 | 1.3 inch IPS screen，resolution 240\*240 | Have connectted with core board when sold | +| 17 | IPS HD screen\*1 | 1.3 inch IPS screen，resolution 240\*240 | Have connected with core board when sold | | 18 | IPEX Wi-Fi antenna connector | IPEX(first generation) Wi-Fi antenna | --- | | 19 | Extension female header | Route V831 general IO，used for connecting peripheral | --- | | 20 | Speaker connector*1 | MX1.25 2P interface（1.25mm pitch） | --- | -| 21 | Loudspeaker*1 | 8Ω1W 1609 composite aluminum membrane speakers | Have connectted with core board when sold | +| 21 | Loudspeaker*1 | 8Ω1W 1609 composite aluminum membrane speakers | Have connected with core board when sold | | 22 | Microphone*1 | Analog electret microphone | --- | ## Resource summary diff --git a/docs/hardware/en/maixII/M2/usage.md b/docs/hardware/en/maixII/M2/usage.md index 6dbdc264..8b20c5dc 100644 --- a/docs/hardware/en/maixII/M2/usage.md +++ b/docs/hardware/en/maixII/M2/usage.md @@ -4,7 +4,7 @@ keywords: MaixII, MaixPy3, Python, Python3, M2dock, Tina, Openwrt desc: maixpy MaixII M2dock start to use --- -## Introduct openwrt +## Introduction openwrt > Allwinnner V831 use Tina Linux, which is created from [OpenWrt](https://openwrt.org). @@ -25,7 +25,7 @@ Because of the change of different system image, the ways to connect to wireless ### V0.5.4 -In this system version, we remove the way to connect wireless network by editting `wpa_supplicant.conf` file of the u-disk, and we use commands to connect wireless network. +In this system version, we remove the way to connect wireless network by editing `wpa_supplicant.conf` file of the u-disk, and we use commands to connect wireless network. We can see there are many linux commands about wifi in this system. @@ -43,7 +43,7 @@ Change `Sipeed_Guest` into your target wireless network name and change `qwert12 ![wifi_test_connect_wireless](./../../../zh/maixII/M2/asserts/usage/wifi_test_connect_wireless.jpg) -From the connection message, we can see `192.168.3.158`, this is the IP address of M2Dock in this network enviroment. +From the connection message, we can see `192.168.3.158`, this is the IP address of M2Dock in this network environment. We can run `ifconfig` on M2Dock to see the ip address, from which we see that the ip address is the same as the wireless network connection message. @@ -77,7 +77,7 @@ Do Not Do Any Operation When Updating. The opkg utility is the lightweight package manager used for upgrading the functionality of the system rather significantly by downloading and installing pre-made packages from package repositories. -#### Related commom commands +#### Related common commands - opkg update # Update the updatable utility - opkg upgrade # Upgrade the upgradable utility @@ -182,4 +182,4 @@ We suggest you use [Maixpy3](/maixpy3) to develop , and its English documents wi ## SDK development -Now we have open V831 source sode here, use this https://github.com/Tina-Linux/tina-V83x if you need. \ No newline at end of file +Now we have open V831 source code here, use this https://github.com/Tina-Linux/tina-V83x if you need. \ No newline at end of file diff --git a/docs/hardware/en/maixII/M2A/config_system.md b/docs/hardware/en/maixII/M2A/config_system.md index 495add2b..2d5f15e7 100644 --- a/docs/hardware/en/maixII/M2A/config_system.md +++ b/docs/hardware/en/maixII/M2A/config_system.md @@ -24,7 +24,7 @@ Click this to download the driver for this serial chip, after installing [ch340 ## Config Tina OS -We suggest beginners use armbian OS because there are many informations about it on internet, and for Tina OS suits those who are good at Linux. +We suggest beginners use Armbian OS because there is a lot of information about it on the internet, and for Tina OS suits those who are good at Linux. The Tina OS configuration steps of Lichee MaixSense are similar to [M2dock](./../M2/usage.md), so here will not retell its usages. NEW-->FPGA Dsign Project-->OK ![](./../../../../../zh/tang/Tang-Nano/assets/LED-1.png) -Set project name and project path (File name and project path shoule be English) +Set project name and project path (File name and project path should be English) ![](./../../../../../zh/tang/Tang-Nano/assets/LED-2.png) Choose correct device: @@ -18,7 +18,7 @@ Choose correct device: ## Prepare codes After creating project, we can start editing codes. -To creat a new file, we can click where the arrow points to in the picture or use shortcut key Ctrl+N. +To create a new file, we can click where the arrow points to in the picture or use shortcut key Ctrl+N. Then choose Verilog File in the pop-up window. ![](./../../../../../zh/tang/Tang-Nano/assets/LED-5.png) diff --git a/docs/hardware/en/tang/Tang-Nano-4K/Nano-4K.md b/docs/hardware/en/tang/Tang-Nano-4K/Nano-4K.md index 6748a44b..0058815b 100644 --- a/docs/hardware/en/tang/Tang-Nano-4K/Nano-4K.md +++ b/docs/hardware/en/tang/Tang-Nano-4K/Nano-4K.md @@ -4,7 +4,7 @@ ## Introduction -Tang Nano 4K is a development board designed based on [Gowin](https://www.gowinsemi.com/en/) little-bee GW1NSR-LV4C FPGA chip. The board is equipped with camera interface and HDMI interface. There is also an onboard USG-JTAG debugger, which make it convinent for users to use. Its Cortex-M3 hardcore can help users study mcu. +Tang Nano 4K is a development board designed based on [Gowin](https://www.gowinsemi.com/en/) little-bee GW1NSR-LV4C FPGA chip. The board is equipped with camera interface and HDMI interface. There is also an onboard USG-JTAG debugger, which make it convenient for users to use. Its Cortex-M3 hardcore can help users study mcu. ![Tang Nano 4K](./assets/4k-1.jpg) ![Tang Nano 4K](./assets/4k-2.jpg) @@ -18,7 +18,7 @@ Tang Nano 4K is a development board designed based on [Gowin](https://www.gowins | FPGA chip | GW1N-1-LV | GW1NSR-LV4C | | logic units | 1152 | 4608 | | Register | 864 | 3456 | -| Hard processor | none | ARM Cortex m3 | +| Hard processor | none | ARM Cortex M3 | | Block SRAM(bits) | 72K | 180K | | User flash(bits) | 96K | 256K | | Number of PLL | 1 | 2 | diff --git a/docs/hardware/en/tang/Tang-Nano-4K/examples/led.md b/docs/hardware/en/tang/Tang-Nano-4K/examples/led.md index f9036327..3cc466e7 100644 --- a/docs/hardware/en/tang/Tang-Nano-4K/examples/led.md +++ b/docs/hardware/en/tang/Tang-Nano-4K/examples/led.md @@ -23,7 +23,7 @@ Choose correct device: ## Prepare codes After creating project, we can start editing codes. -To creat a new file, we can click where the arrow points to in the picture or use shortcut key Ctrl+N. +To create a new file, we can click where the arrow points to in the picture or use shortcut key Ctrl+N. Then choose Verilog File in the pop-up window. ![](./../../../../zh/tang/Tang-Nano/assets/LED-5.png) diff --git a/docs/hardware/en/tang/Tang-Nano-9K/Nano-9K.md b/docs/hardware/en/tang/Tang-Nano-9K/Nano-9K.md index a1362970..9888bc02 100644 --- a/docs/hardware/en/tang/Tang-Nano-9K/Nano-9K.md +++ b/docs/hardware/en/tang/Tang-Nano-9K/Nano-9K.md @@ -2,7 +2,7 @@ ## Introduction -The Tang Nano 9K, powered by [Gowin's](https://www.gowinsemi.com/en/) GW1NR-9 FPGA chip, is a versatile and feature-rich development board. It features several often used connectors, including HDMI, RGB screen, and SPI screen interfaces, aswell as a 32Mbit SPI flash and six LEDs. It has 8640 LUT4 logic units, an onboard 27MHz clock and 2 PLLs meaning, as well as basic FPGA designs, it can also be used for full risc-v softcores such as PicoRV. +The Tang Nano 9K, powered by [Gowin's](https://www.gowinsemi.com/en/) GW1NR-9 FPGA chip, is a versatile and feature-rich development board. It features several often used connectors, including HDMI, RGB screen, and SPI screen interfaces, as well as a 32Mbit SPI flash and six LEDs. It has 8640 LUT4 logic units, an onboard 27MHz clock and 2 PLLs meaning, as well as basic FPGA designs, it can also be used for full risc-v softcores such as PicoRV. ![](./../../../assets/Tang/Nano-9K/9K.png) @@ -68,7 +68,7 @@ Indepth specifications of the tang nano 9k. 3. **[Software User Guide](https://dl.sipeed.com/fileList/TANG/Nano%209K/6_Chip_Manual/EN/General%20Guide/SUG100-2.6E_Gowin%20Software%20User%20Guide.pdf)**: Refer to the "SUG100-2.6E_Gowin Software User Guide.pdf" in the downloaded package for detailed software instructions. -4. **[LED Tutorial](./examples/led.md)**: A simple project to get you acquianted to FPGAs and the tangnano9k. +4. **[LED Tutorial](./examples/led.md)**: A simple project to get you acquainted to FPGAs and the tangnano9k. - **Verilog Code Standards**: It's crucial to adhere to good coding practices. - **Recommended Reading**: - SUG949-1.1E_Gowin HDL Coding User Guide.pdf diff --git a/docs/hardware/en/tang/Tang-Nano-9K/examples/led.md b/docs/hardware/en/tang/Tang-Nano-9K/examples/led.md index fed171d0..dc70c126 100644 --- a/docs/hardware/en/tang/Tang-Nano-9K/examples/led.md +++ b/docs/hardware/en/tang/Tang-Nano-9K/examples/led.md @@ -8,7 +8,7 @@ This tutorial will walk you through the basics of the Gowin IDE, which we'll use ## Create Project -Create Project：File-->NEW-->FPGA Dsign Project-->OK +Create Project：File-->NEW-->FPGA Design Project-->OK ![Create Project](./../../../../zh/tang/Tang-Nano/assets/LED-1.png) Set project name and project path (File name and project path should be English) @@ -136,10 +136,10 @@ Once that's complete, the LEDs start flashing like this： ## Other -If you need to store firmware with no power, just change Accsess mode and choose your target .fs file . +If you need to store firmware with no power, just change Access mode and choose your target .fs file . ![Access_mode](./../../../../zh/tang/Tang-Nano-9K/nano_9k/access_mode.png) -Visit [Qustions&Answers](./../../Tang-Nano-Doc/questions.md) if you have trouble +Visit [Questions&Answers](./../../Tang-Nano-Doc/questions.md) if you have trouble ## End diff --git a/docs/hardware/en/tang/Tang-Nano-9K/examples/picorv.md b/docs/hardware/en/tang/Tang-Nano-9K/examples/picorv.md index 16e4163b..774bb939 100644 --- a/docs/hardware/en/tang/Tang-Nano-9K/examples/picorv.md +++ b/docs/hardware/en/tang/Tang-Nano-9K/examples/picorv.md @@ -34,7 +34,7 @@ python .\sw\pico-programmer.py .\example-fw-flash.v COM13 The COM13 at the end of command line refers to the serial port number of the development board in the system. For example, if it is allocated COM14 in your system, you need change it into COM14. -There is a countdown shows `- Waiting for reset -` when you succeed excute the command, in which time it's required to press the S1 button of the development board to complete the programming. +There is a countdown shows `- Waiting for reset -` when you succeed execute the command, in which time it's required to press the S1 button of the development board to complete the programming. The succeed done log is as below: ```powershell diff --git a/docs/hardware/en/tang/Tang-Nano-9K/examples/rgb_screen.md b/docs/hardware/en/tang/Tang-Nano-9K/examples/rgb_screen.md index a059d415..fff95cf8 100644 --- a/docs/hardware/en/tang/Tang-Nano-9K/examples/rgb_screen.md +++ b/docs/hardware/en/tang/Tang-Nano-9K/examples/rgb_screen.md @@ -32,7 +32,7 @@ The following picture shows the screenshot about this LCD timing. The first picture form shows parameters of the screen and the the following picture is its timing. -From its timing picture, we can know we don't need to set front porch time and back proch time, we just need to set blanking time. +From its timing picture, we can know we don't need to set front porch time and back porch time, we just need to set blanking time. ## Create project @@ -285,7 +285,7 @@ If there is some thing wrong, please fix by yourself. The corresponding pins and ports are as follows form shows -The way to constain pins can refer to the [Light led](./../led/led.md), it contains a way to constain pins. +The way to constain pins can refer to the [Light led](./../led/led.md), it contains a way to constrain pins. If you feel troublesome about the method above, you can copy the content from this [page](./../../../../zh/tang/Tang-Nano-9K/examples/lcd_constrains.md)， and paste it in ".cst" file in this project (if there is no ".cst" file, just create a "physicsl constrains file"). diff --git a/docs/hardware/en/tang/Tang-Nano-Doc/flash-in-linux.md b/docs/hardware/en/tang/Tang-Nano-Doc/flash-in-linux.md index 718cbd93..b89898d5 100644 --- a/docs/hardware/en/tang/Tang-Nano-Doc/flash-in-linux.md +++ b/docs/hardware/en/tang/Tang-Nano-Doc/flash-in-linux.md @@ -5,7 +5,7 @@ keyeords: Linux, FPGA, Gowin It's recommended to use **openFPGALoader** to flash the development board from linux environments. This page covers installation instructions and has been verified on Ubuntu but may work on other linux distributions. -The currently available package on Ubuntu is older ('openfpgaloader') and does not support the latest boards (i.e. tangnano20k), because of this compiling the latest git source is recommended and covered below (adapted from the offical projects documentation: https://trabucayre.github.io/openFPGALoader/guide/install.html). +The currently available package on Ubuntu is older ('openfpgaloader') and does not support the latest boards (i.e. tangnano20k), because of this compiling the latest git source is recommended and covered below (adapted from the official projects documentation: https://trabucayre.github.io/openFPGALoader/guide/install.html). ### Compiling openFPGALoader from git @@ -64,7 +64,7 @@ index 0: ``` -Flash the bitstream to the device as shown below. The board name must be speficied after the `-b` option, `-f` options means the file is programmed to the non-volatile flash, without it it will be stored in SRAM but lost if the device loses power. +Flash the bitstream to the device as shown below. The board name must be specified after the `-b` option, `-f` options means the file is programmed to the non-volatile flash, without it it will be stored in SRAM but lost if the device loses power. ```bash $ sudo ./openFPGALoader -b tangnano9k -f ../../nano9k_lcd/impl/pnr/Tang_nano_9K_LCD.fs diff --git a/docs/hardware/en/tang/Tang-Nano-Doc/install-the-ide.md b/docs/hardware/en/tang/Tang-Nano-Doc/install-the-ide.md index 6c39557d..da3a3a33 100644 --- a/docs/hardware/en/tang/Tang-Nano-Doc/install-the-ide.md +++ b/docs/hardware/en/tang/Tang-Nano-Doc/install-the-ide.md @@ -103,7 +103,7 @@ if the ip not work, try use "gowinlic.sipeed.com" domain's IP. When you run GOWIN IDE, a license manager message box will appear. Once you have a license file you can click `Browse...` and select your license file, then `Check` and finally `Save`. -Broswer lic +Browser lic Check lic Now you can use the GOWIN IDE. @@ -116,7 +116,7 @@ For Linux users, go to the end of this page to see the section [burn-in-linux](# ## Other -It may take some time to receive a license. During this time we sugegst you read the GOWIN Semiconductor Corp official documents, which are installed with the IDE. +It may take some time to receive a license. During this time we suggest you read the GOWIN Semiconductor Corp official documents, which are installed with the IDE. There are three things in the IDE installation path: IDE folder, Programmer folder, uninst.exe diff --git a/docs/hardware/en/tang/Tang-Nano-Doc/questions.md b/docs/hardware/en/tang/Tang-Nano-Doc/questions.md index 36eb52fe..7dddce8e 100644 --- a/docs/hardware/en/tang/Tang-Nano-Doc/questions.md +++ b/docs/hardware/en/tang/Tang-Nano-Doc/questions.md @@ -8,7 +8,7 @@ update: version: v0.3 author: wonder content: - - Add some informations + - Add some information --- @@ -47,7 +47,7 @@ It takes 10 seconds for debugger loading the driver. And you can install the dri ### Download frequency -Make sure the frquency is equal or lower than `2.5MHz`, otherwise it may lead some troubles like burnning bitstream file really slow or failed burnning bitstream file. +Make sure the frequency is equal or lower than `2.5MHz`, otherwise it may lead some troubles like burning bitstream file really slow or failed burning bitstream file. @@ -61,21 +61,21 @@ Then cilck Save This error means the Programmer application does detect debugger or your driver is wrong. Visit [this programmer](https://dl.sipeed.com/shareURL/TANG/programmer) compressed file, download it and extract it, replace the programmer folder install with GOWIN IDE by this extracted file. -If you don't know how to replace the programmer folder, just excute the programmer application in the extracted folder to download bisdtream file instead of the programmer application installed with GOWIN IDE. +If you don't know how to replace the programmer folder, just execute the programmer application in the extracted folder to download bitstream file instead of the programmer application installed with GOWIN IDE. -If this problem still occurs after you use our recommended programmer application, try to rerun this application. If all attemps fail, see the begin of this documents about `converter`. +If this problem still occurs after you use our recommended programmer application, try to rerun this application. If all attempts fail, see the begin of this documents about `converter`. ### Cable lost -Reflash bitstream to solve this. This occurs when flashing bitsteram, board and computer does not well disconneted. +Reflash bitstream to solve this. This occurs when flashing bitstream, board and computer does not well disconnected. -### Cabel open failed +### Cable open failed ![cable_open_failed](./../../../zh/tang/Tang-Nano-Doc/assets/qusetions/cable_open_failed.png) This means the programmer application does not detect the debugger, try this programmer application mentioned in [Error found](#error-found). -If this problem still occurs after you use our recommended programmer application, try to rerun this application. If all attemps fail, see the begin of this documents about `converter`. +If this problem still occurs after you use our recommended programmer application, try to rerun this application. If all attempts fail, see the begin of this documents about `converter`. NEW-->FPGA Dsign Project-->OK +New Project：File-->NEW-->FPGA Design Project-->OK new_project @@ -121,7 +121,7 @@ For time counter inside module, crystal oscillator on the Primer 20K core board parameter count_value = 13_499_999; // The number of times needed to time 0.5S reg [23:0] count_value_reg ; // counter_value -reg count_value_flag; // IO chaneg flag +reg count_value_flag; // IO change flag always @(posedge Clock) begin if ( count_value_reg <= count_value ) begin //not count to 0.5S @@ -142,7 +142,7 @@ reg IO_voltage_reg = 1'b0; // Initial state always @(posedge Clock) begin if ( count_value_flag ) // Flip flag - IO_voltage_reg <= ~IO_voltage_reg; // IO voltage filp + IO_voltage_reg <= ~IO_voltage_reg; // IO voltage flip else // No flip flag IO_voltage_reg <= IO_voltage_reg; // IO voltage constant end @@ -179,7 +179,7 @@ reg IO_voltage_reg = 1'b0; // Initial state always @(posedge Clock) begin if ( count_value_flag ) // Flip flag - IO_voltage_reg <= ~IO_voltage_reg; // IO voltage filp + IO_voltage_reg <= ~IO_voltage_reg; // IO voltage flip else // No flip flag IO_voltage_reg <= IO_voltage_reg; // IO voltage constant end @@ -216,7 +216,7 @@ Since this is the first time we create it, the following dialog box will pop up. The ways to constraint the file can be get from this docs: [SUG935-1.3E_Gowin Design Physical Constraints User Guide.pdf](https://dl.sipeed.com/fileList/TANG/Nano%209K/6_Chip_Manual/EN/General%20Guide/SUG935-1.3E_Gowin%20Design%20Physical%20Constraints%20User%20Guide.pdf) -Here we only use the IO Constranins method shown below to constrain the pins: +Here we only use the IO Constraints method shown below to constrain the pins: ![floor_planner_ioconstrain](./../../../../../../../news/others/20k_lite_start/assets/floor_planner_ioconstrain.png) @@ -228,7 +228,7 @@ Taking into consideration the IO screen printing on the ext_board, we decide to ![l14_port](./../../../../../../../news/others/20k_lite_start/assets/l14_port.png) -So for the IO Constranins under the FloorPlanner interactive window, we fill in the following values for PORT and Location: +So for the IO Constraints under the FloorPlanner interactive window, we fill in the following values for PORT and Location: ![io_constrain_value](./../../../../../../../news/others/20k_lite_start/assets/io_constrain_value.png) @@ -240,7 +240,7 @@ Then we see there is a .cst file in our project, and its content are easy to und ### Place & Route -After finishing constrainting, we run Place & Route. The purpose is to synthesize the generated netlist and our defined constraints to calculate the optimal solution through IDE, then allocate resources reasonably on the FPGA chip. +After finishing constraining, we run Place & Route. The purpose is to synthesize the generated netlist and our defined constraints to calculate the optimal solution through IDE, then allocate resources reasonably on the FPGA chip. Double click Place&Route marked with red box to run. @@ -297,7 +297,7 @@ Click OK to burn fpga. ### Burn to SRAM -Normally this mode is used to verify biststream. +Normally this mode is used to verify bitstream. Because of its fast burning characteristics so the use of more, but of course the power will lose data, so if you want to power on the running program you can't choose this mode. @@ -315,10 +315,10 @@ Here we finished downloading into SRAM。 ### Burn into Flash -Burnning into sram is used for verifying biststream, but can't store program. +Burning into sram is used for verifying biststream, but can't store program. If we want to run application at startup, we need to burn into flash. -This steps are similar to the steps above of burnning to SRAM. +This steps are similar to the steps above of burning to SRAM. Click the function box below Operation to open the device configuration interface, then select the External Flash Mode in the Access Mode to burn into external Flash. Finally click the three dots below to select the.fs we generated to download the firmware. Choose the three dots box below to select our generated `.fs` bitstream file. Generally speaking, bitstream firmware file is in the impl -> pnr directory. Finally, select the Generic Flash device from the following external Flash options. diff --git a/docs/hardware/en/tang/tang-primer-20k/primer-20k.md b/docs/hardware/en/tang/tang-primer-20k/primer-20k.md index c97c905c..86a69b60 100644 --- a/docs/hardware/en/tang/tang-primer-20k/primer-20k.md +++ b/docs/hardware/en/tang/tang-primer-20k/primer-20k.md @@ -103,7 +103,7 @@ Buy it: [Aliexpress](https://www.aliexpress.com/item/1005004653308809.html)

- + @@ -335,7 +335,7 @@ In this case, the default reason is that the wrong Dual-Purpose pin is enabled a Besides, if you have dock ext-board, this can be solved by the enable pin of dip switch. Here art the steps -Firstlt, enable the core board, put the 1 switch on the dip switch down, then do something (like burnning fpga or erasing FPGA) in Programmer application, when the progress bar shows, switch the 1 switch on the dip switch up and down, after which you will find the progress bar works and finish your operations on fpga. +Firstlt, enable the core board, put the 1 switch on the dip switch down, then do something (like burning fpga or erasing FPGA) in Programmer application, when the progress bar shows, switch the 1 switch on the dip switch up and down, after which you will find the progress bar works and finish your operations on fpga.
Align the two TypeC ports with the holes in the shell to prepare for inserting the board into the shellPress where the arrow points at, it's a bit difficult for first time inserting, make sure the two TypeC ports align with the holes. Inster board into the shellPress where the arrow points at, it's a bit difficult for first time inserting, make sure the two TypeC ports align with the holes. Insert board into the shell
insert_screen_direction_2
Avaliable IOAvailable IO 117
diff --git a/docs/hardware/zh/tang/Tang-Nano-4K/Nano-4K.md b/docs/hardware/zh/tang/Tang-Nano-4K/Nano-4K.md index 28a92c37..735a6640 100644 --- a/docs/hardware/zh/tang/Tang-Nano-4K/Nano-4K.md +++ b/docs/hardware/zh/tang/Tang-Nano-4K/Nano-4K.md @@ -18,7 +18,7 @@ Tang Nano 4K开发板板载的GW1NSR-LV4C，是一款系统级封装芯片，内 | FPGA芯片 | GW1N-1-LV | GW1NSR-LV4C | | 逻辑单元 | 1152 | 4608 | | 寄存器 | 864 | 3456 | -| 硬核处理器 | 无 | Coetex M3 | +| 硬核处理器 | 无 | Cortex-M3 | | Block SRAM(bits) | 72K | 180K | | 用户闪存(bits) | 96K | 256K | | 锁相环PLL | 1 | 2 | diff --git a/pages/index/en/README.md b/pages/index/en/README.md index 9883f49c..226a9ff1 100644 --- a/pages/index/en/README.md +++ b/pages/index/en/README.md @@ -1,7 +1,7 @@ --- title: Documentation -keywords: sipeed wiki official, documentation, open source, open source hardware, Lichee, Lichee PI, AI, AIOT, edge AI, face recognization, maixpy, logan, Tang -desc: Wiki of Sipeed official, include software documentation and hardware infomation, and AIOT data etc. +keywords: sipeed wiki official, documentation, open source, open source hardware, Lichee, Lichee PI, AI, AIoT, edge AI, face recognition, maixpy, logan, Tang +desc: Wiki of Sipeed official, include software documentation and hardware information, and AIoT data etc. id: home layout: home --- \ No newline at end of file diff --git a/share_docs/en/change_doc.md b/share_docs/en/change_doc.md index fda1a881..96a651d3 100644 --- a/share_docs/en/change_doc.md +++ b/share_docs/en/change_doc.md @@ -13,7 +13,7 @@ So if you find something wrong or incorrect, you can edit this page. ![](./../assets/3.png) The content may show as below, just correct what you think need to be changed. ![](./../assets/4.png) -5. Pull requset after your finishing editing and add the reason why change it. +5. Pull request after your finishing editing and add the reason why change it. ![](./../assets/5.png) We will merge request if ok. \ No newline at end of file