Skip to content

Commit

Permalink
TW translations (#29)
Browse files Browse the repository at this point in the history 
* Update AMB23 and BW16 Network Examples TW translations
* Remove MicroSpeech from BW16
* Update TW translations for community examples
  • Loading branch information
@daphwl
daphwl committed May 11, 2022
1 parent a9cca88 commit a2b5066
Show file tree
Hide file tree
Showing 168 changed files with 3,926 additions and 3,267 deletions.
759 changes: 409 additions & 350 deletions docs/source/ambd_arduino/AMB21/api_documents/Class Adafruit_GPS.rst
View file

Large diffs are not rendered by default.

77 changes: 43 additions & 34 deletions docs/source/ambd_arduino/AMB21/api_documents/Class AmebaServo.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
Class AmebaServo
################

AmebaServo Class
-----------------

.. class:: AmebaServo()

**Description**

Defines a class of manipulating servo motors connected to Arduino pins.
Expand Down Expand Up @@ -42,8 +41,10 @@ class AmebaServo
| AmebaServo::attached | Check if the servo is attached. |
+-------------------------------+-------------------------------------+

AmebaServo::attach
------------------
------------------------------------------------------------------------------


.. method:: AmebaServo::attach

**Description**

Expand All @@ -62,20 +63,18 @@ failure.
**Parameters**

pin: The Arduino pin number to be attached.
``pin`` : The Arduino pin number to be attached.

min: Minimum values for writes.
``min`` : Minimum values for writes.

max: Maximum values for writes.
``max`` : Maximum values for writes.

**Returns**

The function returns channel number or 0

**Example Code**

Example: ServoSweep

The code demos servo motor sweeping from 0 degrees to 180 degrees then
sweep back to 0 degrees in the step of 1 degree.

Expand Down Expand Up @@ -135,15 +134,14 @@ sweep back to 0 degrees in the step of 1 degree.
}
}
**Notes and Warnings**
**Note and Warnings**

Every time must include the header file “AmebaServo.h” in front of the
project to use the class function.
project to use the class function. 

 
--------------------------------------------------------------------------------------------------------------------

AmebaServo::detach
------------------
.. method:: AmebaServo::detach

**Description**

Expand All @@ -170,9 +168,9 @@ NA
Every time must include the header file “AmebaServo.h” in front of the
project to use the class function.

 
--------------------------------------------------------------------------------------------------------------------

**AmebaServo::write**
.. method:: AmebaServo::write

**Description**

Expand All @@ -181,11 +179,13 @@ being treated as an angle, otherwise as pulse-width in microseconds.

**Syntax**

void AmebaServo::write(int value);
.. code:: c++

void AmebaServo::write(int value);

**Parameters**

value: The value < 200 its treated as an angle; otherwise as pulse width
``value`` : The value < 200 its treated as an angle; otherwise as pulse width
in microseconds.

**Returns**
Expand All @@ -194,7 +194,7 @@ The function returns nothing.

**Example Code**

Example: ServoSweep
Example: `ServoSweep`

The code demos servo motor sweeping from 0 degrees to 180 degrees then
sweep back to 0 degrees in the step of 1 degree. Please refer to code in
Expand All @@ -205,21 +205,23 @@ sweep back to 0 degrees in the step of 1 degree. Please refer to code in
Every time must include the header file “AmebaServo.h” in front of the
project to use the class function.

 
--------------------------------------------------------------------------------------------------------------------

**AmebaServo::writeMicroseconds**
.. method:: AmebaServo::writeMicroseconds

**Description**

Write pulse width to the servo in microseconds.

**Syntax**

void AmebaServo::writeMicroseconds(int value);
.. code:: c++

void AmebaServo::writeMicroseconds(int value);

**Parameters**

value: Write value the pulse width in microseconds.
``value`` : Write value the pulse width in microseconds.

**Returns**

Expand All @@ -234,9 +236,9 @@ NA
Every time must include the header file “AmebaServo.h” in front of the
project to use the class function.

 
--------------------------------------------------------------------------------------------------------------------

**AmebaServo::read**
.. method:: AmebaServo::read

**Description**

Expand All @@ -245,7 +247,9 @@ and 180 degrees.

**Syntax**

int AmebaServo::read(void);
.. code:: c++

void AmebaServo::read(void);

**Parameters**

Expand All @@ -264,9 +268,10 @@ NA
Every time must include the header file “AmebaServo.h” in front of the
project to use the class function.

 
--------------------------------------------------------------------------------------------------------------------

**AmebaServo::readMicroseconds**

.. method:: AmebaServo::readMicroseconds 

**Description**

Expand All @@ -275,7 +280,9 @@ otherwise returns “false”.

**Syntax**

int AmebaServo::readMicroseconds(void);
.. code:: c++

void AmebaServo::readMicroseconds(void);

**Parameters**

Expand All @@ -294,17 +301,19 @@ NA
Every time must include the header file “AmebaServo.h” in front of the
project to use the class function.

 
--------------------------------------------------------------------------------------------------------------------

**AmebaServo::attached**
.. method:: AmebaServo::attached

**Description**

It returns true if this servo is attached, otherwise false.

**Syntax**

bool AmebaServo::attached(void);
.. code:: c++

void AmebaServo::attached(void);

**Parameters**

Expand All @@ -316,7 +325,7 @@ The function returns a Boolean value as true or false.

**Example Code**

Example: ServoSweep
Example: `ServoSweep`

The code demos servo motor sweeping from 0 degrees to 180 degrees then
sweep back to 0 degrees in the step of 1 degree. Please refer to code in
Expand Down
1 change: 0 additions & 1 deletion .../examples_and_components/Peripheral Examples/TensorFlow Lite - Micro Speech.rst
View file

This file was deleted.

1 change: 0 additions & 1 deletion ...source/ambd_arduino/BW16_/examples_and_components/Peripheral Examples/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ Peripheral Examples
SPI - Show PM2.5 Concentration On ILI9341 TFT LCD
TensorFlow Lite - Hello World
TensorFlow Lite - Magic Wand
TensorFlow Lite - Micro Speech
TensorFlow Lite - Person Detection
UART - Communicate with PC over USB to Serial Module
UART - Retrieve GPS Position
Expand Down
8 changes: 4 additions & 4 deletions docs/source/ambd_arduino/examples/network/WiFi - Set up Server to communicate.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,19 +91,19 @@ The string sent to server is returned and showed at the client side.
| Use ``client.stop()`` to disconnect from the server.
| https://www.arduino.cc/en/Reference/WiFIClientStop
.. |1| image:: /media/ambd_arduino/WiFi_Set_up_Server_to_communicate/image1.png
.. |1| image:: /media/ambd_arduino/WiFi_Set_Up_Server_To_Communicate/image1.png
:width: 716
:height: 867
:scale: 80 %
.. |2| image:: /media/ambd_arduino/WiFi_Set_up_Server_to_communicate/image2.png
.. |2| image:: /media/ambd_arduino/WiFi_Set_Up_Server_To_Communicate/image2.png
:width: 704
:height: 355
:scale: 80 %
.. |3| image:: /media/ambd_arduino/WiFi_Set_up_Server_to_communicate/image3.png
.. |3| image:: /media/ambd_arduino/WiFi_Set_Up_Server_To_Communicate/image3.png
:width: 799
:height: 574
:scale: 70 %
.. |4| image:: /media/ambd_arduino/WiFi_Set_up_Server_to_communicate/image4.png
.. |4| image:: /media/ambd_arduino/WiFi_Set_Up_Server_To_Communicate/image4.png
:width: 704
:height: 355
:scale: 80 %

0 comments on commit a2b5066

Please sign in to comment.