Skip to content

Commit 0fb1445

Browse files
delete backslash.
1 parent fc6d07d commit 0fb1445

6 files changed

Lines changed: 39 additions & 39 deletions

File tree

mruby_io_ADC_en.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# ADC
22

3-
- A class that supports Analog-to-Digital Conversion (`ADC`) functionality.
3+
- A class that supports Analog-to-Digital Conversion (ADC) functionality.
44
- Generally, it is capable of converting analog voltage values to digital values.
55

66
## Constructor
77

88

99
### ADC.new( pin, *params )
1010

11-
- Generate an `ADC` object by specifying the physical pin indicated by "pin."
11+
- Generate an ADC object by specifying the physical pin indicated by "pin."
1212
- Typically, "pin" is specified as an integer, but alternative methods (e.g., "B1" in PIC) are also acceptable.
1313
- If the device has a switch between analog and digital modes for the pin, it will be switched to analog mode at this point.
1414
- Generally, there is no need to specify additional parameters, such as "params." However, for certain models that require additional feature specifications like sampling speed, they can be specified here.

mruby_io_GPIO_en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
### GPIO.setmode( pin, params ) -> nil
1212

13-
- Specify the physical pin indicated by "pin" and change the mode of the `GPIO`.
13+
- Specify the physical pin indicated by "pin" and change the mode of the GPIO.
1414
- Refer to the constructor for other information.
1515

1616
Example of use:
@@ -83,7 +83,7 @@ GPIO.write_at( 1, 0 ) # output zero to pin 1.
8383

8484
### GPIO.new( pin, params )
8585

86-
- Specify the physical pin indicated by the pin and generate a `GPIO` object.
86+
- Specify the physical pin indicated by the pin and generate a GPIO object.
8787
- At the same time, specify a param to indicate the mode, such as input/output direction.
8888
- The pin is typically specified as an integer, but other methods (such as "B1" in PIC) may be used.
8989
- Although one bit is the basic unit, pin specification that combines multiple bits may be necessary depending on the device.
@@ -169,7 +169,7 @@ gpio1.write( 1 )
169169

170170
### setmode( param ) -> nil
171171

172-
- Change the `GPIO` mode at any timing.
172+
- Change the GPIO mode at any timing.
173173
- When IN, OUT, or HIGH_Z is specified while PULL_UP or other settings have already been set, the previous settings will be invalidated.
174174

175175
Example of use:

mruby_io_I2C_en.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# I2C
22

3-
- A class that supports `I2C` bus.
3+
- A class that supports I2C bus.
44
- This specification supports only master devices with 7-bit addresses.
55

66
---
@@ -10,7 +10,7 @@
1010

1111
### I2C.new( id=nil, *params )
1212

13-
- Generates an `I2C` object by specifying the physical unit indicated by "id."
13+
- Generates an I2C object by specifying the physical unit indicated by "id."
1414
- "id" can be omitted when there is only one physical unit.
1515

1616
Optional Parameters
@@ -43,10 +43,10 @@ Device-specific
4343

4444
### read( i2c_adrs_7, read_bytes, *param ) -> String
4545

46-
- Reads data of `read_bytes` bytes from the device with the address `i2c_adrs_7`.
47-
- If the device returns NAK in the middle, a String of shorter length than `read_bytes` may be returned.
48-
- If data is specified in the `param`, it will be output before the repeated start, and then reading will start.
49-
- Output specifications are the same as for `write()`.
46+
- Reads data of read_bytes bytes from the device with the address i2c_adrs_7.
47+
- If the device returns NAK in the middle, a String of shorter length than read_bytes may be returned.
48+
- If data is specified in the param, it will be output before the repeated start, and then reading will start.
49+
- Output specifications are the same as for write().
5050

5151
Example of use:
5252

@@ -73,9 +73,9 @@ I2C bus sequence
7373

7474
### write( i2c_adrs_7 , *outputs ) -> Integer
7575

76-
- Writes data specified in `outputs` to the device with the address `i2c_adrs_7`.
76+
- Writes data specified in outputs to the device with the address i2c_adrs_7.
7777
- The number of bytes successfully written is returned as the return value.
78-
- `outputs` can be specified as an Integer, Array<Integer>, or String.
78+
- outputs can be specified as an Integer, Array<Integer>, or String.
7979

8080
Example of use:
8181

@@ -136,8 +136,8 @@ i2c.send_stop
136136

137137
### raw_read( read_bytes, ack_nack = false ) -> String
138138

139-
- Reads `read_bytes` bytes from the I2C bus and returns them.
140-
- `ack_nack = true` outputs ACK at the last byte reading, and `false` outputs NACK.
139+
- Reads read_bytes bytes from the I2C bus and returns them.
140+
- ack_nack = true outputs ACK at the last byte reading, and false outputs NACK.
141141

142142
Example of use:
143143

@@ -149,9 +149,9 @@ str = i2c.raw_read( 20 )
149149

150150
### raw_write( *outputs ) -> Integer
151151

152-
- Writes data specified in `outputs` to the I2C bus.
152+
- Writes data specified in outputs to the I2C bus.
153153
- The number of bytes successfully written is returned as the return value.
154-
- `outputs` can be specified as an Integer, Array<Integer>, or String.
154+
- outputs can be specified as an Integer, Array<Integer>, or String.
155155

156156
Example of use:
157157

mruby_io_PWM_en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PWM
22

3-
- A class that supports Pulse Width Modulation (`PWM`) functionality.
3+
- A class that supports Pulse Width Modulation (PWM) functionality.
44

55
---
66

@@ -11,8 +11,8 @@
1111

1212
- Generate a PWM object by specifying the physical pin indicated by "pin."
1313
- Typically, "pin" is specified as an integer, but alternative methods (e.g., "B1" in PIC) are also acceptable.
14-
- When specifying the parameter `frequency`, the output starts with a duty cycle of 50%.
15-
- If you want to start the output with a duty cycle other than 50%, specify the parameter `duty` simultaneously.
14+
- When specifying the parameter frequency, the output starts with a duty cycle of 50%.
15+
- If you want to start the output with a duty cycle other than 50%, specify the parameter duty simultaneously.
1616

1717
Optional Parameters
1818

mruby_io_SPI_en.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# SPI
22

3-
- A class that supports `SPI` bus.
3+
- A class that supports SPI bus.
44
- This specification defines only master devices and transfers in 8-bit units.
5-
- The Chip Select (CS/SS) will be managed using `GPIO` functionality and is not defined within the `SPI` class.
5+
- The Chip Select (CS/SS) will be managed using GPIO functionality and is not defined within the SPI class.
66

77
---
88

@@ -11,7 +11,7 @@
1111

1212
### SPI.new( id=nil, *params )
1313

14-
- Generates an `SPI` object by specifying the physical unit indicated by "id."
14+
- Generates an SPI object by specifying the physical unit indicated by "id."
1515
- "id" can be omitted when there is only one physical unit.
1616

1717
Optional Parameters
@@ -44,7 +44,7 @@ Device-specific
4444

4545
### setmode( *params )
4646

47-
- Changes the operating mode (parameters) of the `SPI`.
47+
- Changes the operating mode (parameters) of the SPI.
4848
- The parameters are specified according to the constructor.
4949

5050
Example of use:
@@ -57,7 +57,7 @@ spi.setmode( mode:3 )
5757

5858
### read( read_bytes ) -> String
5959

60-
- Reads data of `read_bytes` bytes from the SPI bus.
60+
- Reads data of read_bytes bytes from the SPI bus.
6161
- At the same time, data will be output as 0.
6262

6363
Example of use:
@@ -70,8 +70,8 @@ data = spi.read( 32 )
7070

7171
### write( *outputs ) -> nil
7272

73-
- Outputs data specified in `outputs` to the SPI bus.
74-
- `outputs` can be specified as an Integer, Array<Integer>, or String.
73+
- Outputs data specified in outputs to the SPI bus.
74+
- outputs can be specified as an Integer, Array<Integer>, or String.
7575

7676
Example of use:
7777

@@ -85,9 +85,9 @@ i2c.write( 0x02, 0xee, 0xad, 0x00, data_string ) # useful for EEPROM
8585

8686
### transfer( outputs, additional_read_bytes = 0 ) -> String
8787

88-
- Outputs data specified in `outputs` to the SPI bus while simultaneously reading data (General-purpose transfer).
89-
- `outputs` can be specified as an Integer, Array<Integer>, or String.
90-
- If `additional_read_bytes` is specified, it will output 0x00 after the `outputs`.
88+
- Outputs data specified in outputs to the SPI bus while simultaneously reading data (General-purpose transfer).
89+
- outputs can be specified as an Integer, Array<Integer>, or String.
90+
- If additional_read_bytes is specified, it will output 0x00 after the outputs.
9191

9292
Example of use:
9393

mruby_io_UART_en.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
### UART.new( id=nil, *params )
1111

12-
- Generates a `UART` object by specifying the physical unit indicated by "id."
12+
- Generates a UART object by specifying the physical unit indicated by "id."
1313
- The default parameter values follow the settings below if possible.
1414
- Baud rate: 9600
1515
- Data bits: 8 bits
@@ -63,7 +63,7 @@ Device-specific
6363

6464
### setmode( *params )
6565

66-
- Changes the mode (parameters) of `UART`.
66+
- Changes the mode (parameters) of UART.
6767
- The parameter specification follows that of the constructor.
6868

6969
Example of use:
@@ -76,7 +76,7 @@ uart1.setmode( bardrate:38400 )
7676

7777
### read( read_bytes ) -> String
7878

79-
- Reads data of the specified number of bytes, `read_bytes`.
79+
- Reads data of the specified number of bytes, read_bytes.
8080
- If the specified number of bytes has not arrived, it will block until they arrive.
8181

8282
Example of use:
@@ -87,7 +87,7 @@ val = uart1.read( 10 )
8787

8888
Note
8989

90-
- If you do not want to block, you can check the number of bytes that can be read in advance using the `bytes_available` method.
90+
- If you do not want to block, you can check the number of bytes that can be read in advance using the bytes_available method.
9191

9292
---
9393

@@ -122,14 +122,14 @@ val = uart1.gets()
122122

123123
Note
124124

125-
- If you do not want to block, you can check if reading a line is possible in advance using the `can_read_line` method.
126-
- The maximum character length depends on the size of the read buffer. If the buffer becomes full with data that does not contain a newline character, it will not be possible to read using `gets`.
125+
- If you do not want to block, you can check if reading a line is possible in advance using the can_read_line method.
126+
- The maximum character length depends on the size of the read buffer. If the buffer becomes full with data that does not contain a newline character, it will not be possible to read using gets.
127127

128128
---
129129

130130
### puts( string ) -> nil
131131

132-
- Sends one line and sends a newline code at the end of the argument `string`.
132+
- Sends one line and sends a newline code at the end of the argument string.
133133
- The newline code is LF only by default.
134134

135135
Example of use:
@@ -219,7 +219,7 @@ uart1.clear_tx_buffer()
219219
### send_break( time )
220220

221221
- Sends a break signal.
222-
- The `time` is optional and specified in seconds.
222+
- The time is optional and specified in seconds.
223223

224224
Example of use:
225225

@@ -229,4 +229,4 @@ uart1.send_break( 0.1 )
229229

230230
Device-specific
231231

232-
- Depending on the hardware, `time` may be fixed (e.g., 12 bits) and cannot be changed.
232+
- Depending on the hardware, time may be fixed (e.g., 12 bits) and cannot be changed.

0 commit comments

Comments
 (0)