Skip to content

Commit 611ad74

Browse files
Update README.adoc
1 parent 2f39b60 commit 611ad74

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.adoc

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Controls motor movement.
1919

2020
#### Syntax
2121

22-
Cing.RunMotor(motor,state,mode)
22+
`Cing.RunMotor(motor,state,mode)`
2323

2424
#### Parameters
2525

26-
motor: "A", "B", "AB"
26+
`motor:` `"A"`, `"B"`, `"AB"`. `"A"` controls motor `A` only `"B"` controls motor `B` only and `"AB"` controls motors `A` and `B` simultaneously.
2727

28-
state: 0 or 1 or -1 if digital mode is used and 0 to 100 if analog mode is used. Positive values are used for forward, negative values are used for reverse.
28+
`state:` `0` or `1` or `-1` if digital mode is used and `0` to `100` if analog mode is used. Positive values are used for forward, negative values are used for reverse.
2929

30-
mode:"digital" or "analog"
30+
`mode:` `"digital"` or `"analog"`
3131

3232
---
3333

@@ -38,17 +38,16 @@ mode:"digital" or "analog"
3838

3939
#### Description
4040

41-
Reads the value from external button, either 0 or 1.
42-
41+
Reads the value from external button, either `0` or `1`.
4342

4443
#### Syntax
4544

46-
Cing.ReadButtonExternal()
45+
`Cing.ReadButtonExternal()`
4746

4847

4948
#### Returns
5049

51-
0 if button is not pressed or 1 if button is pressed.
50+
`0` if button is not pressed or `1` if button is pressed.
5251

5352
---
5453

@@ -61,10 +60,10 @@ Reads the value from external potentiometer.
6160

6261
#### Syntax
6362

64-
Cing.ReadPotentiometerExternal()
63+
`Cing.ReadPotentiometerExternal()`
6564

6665
#### Returns
67-
From 0 to 100 depending on potentiometer position.
66+
From `0` to `100` depending on potentiometer position.
6867

6968
---
7069

@@ -80,19 +79,19 @@ Reads the value from light sensor.
8079

8180
#### Syntax
8281

83-
Cing.ReadLightSensor(sensor,mode)
82+
`Cing.ReadLightSensor(sensor,mode)`
8483

8584

8685
#### Parameters
8786

88-
sensor: 1 or 2 used for selection of sensor
87+
sensor: `1` or `2` used for selection of sensor
8988

90-
mode:"digital" or "analog"
89+
mode: `"digital"` or `"analog"`
9190

9291

9392
#### Returns
9493

95-
From 0 to 100 in analog mode and either 0 or 1 in digital mode.
94+
From `0` to `100` in analog mode and either `0` or `1` in digital mode.
9695

9796
---
9897

@@ -108,12 +107,12 @@ Reads the value from external shine sensor.
108107

109108
#### Syntax
110109

111-
Cing.ReadShineSensor()
110+
`Cing.ReadShineSensor()`
112111

113112

114113
#### Returns
115114

116-
From 0 to 100 depending on ambient light.
115+
From `0` to `100` depending on ambient light.
117116

118117
---
119118

@@ -131,12 +130,12 @@ Reads the value from external ultrasonic sensor.
131130

132131
#### Syntax
133132

134-
Cing.UltrasonicSensor()
133+
`Cing.UltrasonicSensor()`
135134

136135

137136
#### Returns
138137

139-
Distance in mm from 0 to 400mm.
138+
Distance in mm from `0` to `400`.
140139

141140
---
142141

0 commit comments

Comments
 (0)