Skip to content

Commit e7d34fa

Browse files
JessamyTJessamyT
authored
DOCS-2949: Fix board and encoder example snippets (#778)
1 parent 656d89f commit e7d34fa

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

‎src/viam/components/board/board.py

+20-20
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ async def read(self, *, extra: Optional[Dict[str, Any]] = None, timeout: Optiona
6565
6666
::
6767
68-
my_board = Board.from_robot(robot=robot, name="my_board")
68+
my_board = Board.from_robot(robot=machine, name="my_board")
6969
7070
# Get the Analog "my_example_analog_reader".
7171
reader = await my_board.analog_reader_by_name(
@@ -89,7 +89,7 @@ async def write(self, value: int, *, extra: Optional[Dict[str, Any]] = None, tim
8989
9090
::
9191
92-
my_board = Board.from_robot(robot=robot, name="my_board")
92+
my_board = Board.from_robot(robot=machine, name="my_board")
9393
9494
# Get the Analog "my_example_analog_writer".
9595
writer = await my_board.analog_by_name(
@@ -127,7 +127,7 @@ async def value(self, *, extra: Optional[Dict[str, Any]] = None, timeout: Option
127127
128128
::
129129
130-
my_board = Board.from_robot(robot=robot, name="my_board")
130+
my_board = Board.from_robot(robot=machine, name="my_board")
131131
132132
# Get the DigitalInterrupt "my_example_digital_interrupt".
133133
interrupt = await my_board.digital_interrupt_by_name(
@@ -163,13 +163,13 @@ async def set(self, high: bool, *, extra: Optional[Dict[str, Any]] = None, timeo
163163
164164
::
165165
166-
my_board = Board.from_robot(robot=robot, name="my_board")
166+
my_board = Board.from_robot(robot=machine, name="my_board")
167167
168168
# Get the GPIOPin with pin number 15.
169169
pin = await my_board.gpio_pin_by_name(name="15")
170170
171171
# Set the pin to high.
172-
await pin.set(high="true")
172+
await pin.set(high=True)
173173
174174
Args:
175175
high (bool): When true, sets the pin to high. When false, sets the pin to low.
@@ -185,7 +185,7 @@ async def get(self, *, extra: Optional[Dict[str, Any]] = None, timeout: Optional
185185
186186
::
187187
188-
my_board = Board.from_robot(robot=robot, name="my_board")
188+
my_board = Board.from_robot(robot=machine, name="my_board")
189189
190190
# Get the GPIOPin with pin number 15.
191191
pin = await my_board.gpio_pin_by_name(name="15")
@@ -207,7 +207,7 @@ async def get_pwm(self, *, extra: Optional[Dict[str, Any]] = None, timeout: Opti
207207
208208
::
209209
210-
my_board = Board.from_robot(robot=robot, name="my_board")
210+
my_board = Board.from_robot(robot=machine, name="my_board")
211211
212212
# Get the GPIOPin with pin number 15.
213213
pin = await my_board.gpio_pin_by_name(name="15")
@@ -229,14 +229,14 @@ async def set_pwm(self, duty_cycle: float, *, extra: Optional[Dict[str, Any]] =
229229
230230
::
231231
232-
my_board = Board.from_robot(robot=robot, name="my_board")
232+
my_board = Board.from_robot(robot=machine, name="my_board")
233233
234234
# Get the GPIOPin with pin number 15.
235235
pin = await my_board.gpio_pin_by_name(name="15")
236236
237237
# Set the duty cycle to .6, meaning that this pin will be in the high state for
238238
# 60% of the duration of the PWM interval period.
239-
await pin.set_pwm(cycle=.6)
239+
await pin.set_pwm(duty_cycle=.6)
240240
241241
Args:
242242
duty_cycle (float): The duty cycle.
@@ -252,7 +252,7 @@ async def get_pwm_frequency(self, *, extra: Optional[Dict[str, Any]] = None, tim
252252
253253
::
254254
255-
my_board = Board.from_robot(robot=robot, name="my_board")
255+
my_board = Board.from_robot(robot=machine, name="my_board")
256256
257257
# Get the GPIOPin with pin number 15.
258258
pin = await my_board.gpio_pin_by_name(name="15")
@@ -282,7 +282,7 @@ async def set_pwm_frequency(
282282
283283
::
284284
285-
my_board = Board.from_robot(robot=robot, name="my_board")
285+
my_board = Board.from_robot(robot=machine, name="my_board")
286286
287287
# Get the GPIOPin with pin number 15.
288288
pin = await my_board.gpio_pin_by_name(name="15")
@@ -304,7 +304,7 @@ async def analog_by_name(self, name: str) -> Analog:
304304
305305
::
306306
307-
my_board = Board.from_robot(robot=robot, name="my_board")
307+
my_board = Board.from_robot(robot=machine, name="my_board")
308308
309309
# Get the Analog "my_example_analog_reader".
310310
reader = await my_board.analog_by_name(name="my_example_analog_reader")
@@ -326,7 +326,7 @@ async def digital_interrupt_by_name(self, name: str) -> DigitalInterrupt:
326326
327327
::
328328
329-
my_board = Board.from_robot(robot=robot, name="my_board")
329+
my_board = Board.from_robot(robot=machine, name="my_board")
330330
331331
# Get the DigitalInterrupt "my_example_digital_interrupt".
332332
interrupt = await my_board.digital_interrupt_by_name(
@@ -349,7 +349,7 @@ async def gpio_pin_by_name(self, name: str) -> GPIOPin:
349349
350350
::
351351
352-
my_board = Board.from_robot(robot=robot, name="my_board")
352+
my_board = Board.from_robot(robot=machine, name="my_board")
353353
354354
# Get the GPIOPin with pin number 15.
355355
pin = await my_board.gpio_pin_by_name(name="15")
@@ -371,7 +371,7 @@ async def analog_names(self) -> List[str]:
371371
372372
::
373373
374-
my_board = Board.from_robot(robot=robot, name="my_board")
374+
my_board = Board.from_robot(robot=machine, name="my_board")
375375
376376
# Get the name of every Analog configured on the board.
377377
names = await my_board.analog_names()
@@ -390,7 +390,7 @@ async def digital_interrupt_names(self) -> List[str]:
390390
391391
::
392392
393-
my_board = Board.from_robot(robot=robot, name="my_board")
393+
my_board = Board.from_robot(robot=machine, name="my_board")
394394
395395
# Get the name of every DigitalInterrupt configured on the board.
396396
names = await my_board.digital_interrupt_names()
@@ -411,7 +411,7 @@ async def set_power_mode(
411411
412412
::
413413
414-
my_board = Board.from_robot(robot=robot, name="my_board")
414+
my_board = Board.from_robot(robot=machine, name="my_board")
415415
416416
# Set the power mode of the board to OFFLINE_DEEP.
417417
status = await my_board.set_power_mode(mode=PowerMode.POWER_MODE_OFFLINE_DEEP)
@@ -432,9 +432,9 @@ async def stream_ticks(self, interrupts: List[DigitalInterrupt], *, timeout: Opt
432432
::
433433
434434
435-
my_board = Board.from_robot(robot=robot, name="my_board")
436-
di8 = await my_board.digital_interrupt_by_name(name="8"))
437-
di11 = await my_board.digital_interrupt_by_name(name="11"))
435+
my_board = Board.from_robot(robot=machine, name="my_board")
436+
di8 = await my_board.digital_interrupt_by_name(name="8")
437+
di11 = await my_board.digital_interrupt_by_name(name="11")
438438
439439
# Iterate over stream of ticks from pins 8 and 11.
440440
async for tick in await my_board.stream_ticks([di8, di11]):

‎src/viam/components/encoder/encoder.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ async def reset_position(
4545
4646
::
4747
48-
my_encoder = Encoder.from_robot(robot=robot, name='my_encoder')
48+
my_encoder = Encoder.from_robot(robot=machine, name='my_encoder')
4949
5050
# Reset the zero position of the encoder.
5151
await my_encoder.reset_position()
@@ -73,7 +73,7 @@ async def get_position(
7373
7474
::
7575
76-
my_encoder = Encoder.from_robot(robot=robot, name='my_encoder')
76+
my_encoder = Encoder.from_robot(robot=machine, name='my_encoder')
7777
7878
# Get the position of the encoder in ticks
7979
position = await my_encoder.get_position(PositionType.POSITION_TYPE_TICKS_COUNT)
@@ -105,7 +105,7 @@ async def get_properties(
105105
106106
::
107107
108-
my_encoder = Encoder.from_robot(robot=robot, name='my_encoder')
108+
my_encoder = Encoder.from_robot(robot=machine, name='my_encoder')
109109
110110
# Get whether the encoder returns position in ticks or degrees.
111111
properties = await my_encoder.get_properties()

0 commit comments

Comments
 (0)