Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-14 18:47:32 +00:00
Code Issues Releases Activity
582 Commits 10 Branches 125 Tags
70ffbfa4f3fc480bf7253a0e47bbf2c0098876f4
Commit Graph
50 Commits
Author SHA1 Message Date
Laurens Valk 6aa6059974 doc/pupdevices: add Motor action examples 2020-07-21 16:14:35 +02:00
Laurens Valk 98f247688e doc/pupdevices: add Motor measuring examples 2020-07-21 14:50:26 +02:00
Laurens Valk 51f9d916e0 doc/pupdevices: add Motor init examples 2020-07-21 14:50:26 +02:00
Laurens Valk 8a9386ffc5 doc/pupdevices: add DCMotor examples 2020-07-21 14:50:26 +02:00
Laurens Valk ac96985c71 doc/pupdevices/ForceSensor: add examples 2020-07-13 15:40:59 +02:00
Laurens Valk b98f487f3c doc/pupdevices/ColorSensor: add examples 2020-07-13 14:24:57 +02:00
Laurens Valk 6132ae66da doc/pupdevices/ColorDistanceSensor: add examples 2020-07-11 19:40:00 +02:00
Laurens Valk a02c7023e5 doc/pupdevices/ColorDistanceSensor: group methods 
We are already using a rubric for the lights, so add two more to better
group the many methods of this sensor.
 2020-07-11 17:09:49 +02:00
Laurens Valk d15aa22131 doc/pupdevices/Light: and blink and fade examples 2020-07-11 13:00:28 +02:00
Laurens Valk 19009d1637 doc/pupdevices: InfraredSensor, TiltSensor example 2020-07-11 12:46:30 +02:00
Laurens Valk 4dbaf5f68e doc/pupdevices/UltrasonicSensor: math example 2020-07-10 13:06:22 +02:00
Laurens Valk af2b1c66c9 doc/pupdevices/UltrasonicSensor: add example 2020-07-10 12:42:20 +02:00
Laurens Valk 93da01c7ce api/pupdevices/ColorDistanceSensor: add hsv 
The hsv and color_map methods are the same as for the SPIKE ColorSensor class, except for the surface kwarg.
 2020-07-07 14:07:35 +02:00
Laurens Valk 8078b6febb doc/_common/ColorLight: docstring clean up 
This adds a (commented out) preview of the methods to the city hub light
 2020-07-07 09:44:16 +02:00
Laurens Valk d66e18b113 api/pupdevices: add TiltSensor 
This class and its methods are subject to change when the complete
API for IMUs is introduced.
 2020-07-01 13:33:36 +02:00
Laurens Valk 55fe666dac api/pupdevices: add InfraredSensor 2020-07-01 12:02:13 +02:00
Laurens Valk 0779b8df16 doc/pupdevices: workaround to show class attribute 
We are using an older version of Sphinx which does not support
autodoc of inherited class attributes yet. This works
around it by just referencing the EV3 attribute, which does work.
 2020-06-14 15:39:04 +02:00
Laurens Valk 80840396aa api/pupdevices: add Powered Up Light 2020-06-08 15:26:19 +02:00
Laurens Valk e0ac54ec0a api/pupdevices/ForceSensor: add methods 2020-05-27 13:58:30 +02:00
Laurens Valk 8273c00881 api/pupdevices/UltrasonicSensor: add methods 
This is identical to the EV3 Ultrasonic Sensor methods.
 2020-05-27 13:58:30 +02:00
Laurens Valk 4da7b456bb api/pupdevices: initial color sensor hsv api 
Provide a simple yet powerful way to calibrate the color() method.
 2020-05-27 13:58:30 +02:00
Laurens Valk 7498751ee3 doc/pupdevices: add diagrams with light indices 
Make this clear once and for all.
This order comes from the sensor itself.
 2020-05-27 13:58:30 +02:00
Laurens Valk a8b0306afe doc/pupdevices: flip ultrasonic sensor diagram 2020-05-27 13:58:30 +02:00
Laurens Valk 2dd133d5e5 api/pupdevices: add ForceSensor 
Initial class without any methods for the SPIKE Force Sensor
 2020-05-27 13:58:30 +02:00
Laurens Valk e67c048b18 api/pupdevices: add UltrasonicSensor 
Initial class without any methods for the SPIKE Ultrasonic Sensor
 2020-05-27 13:58:30 +02:00
Laurens Valk 10b6808037 api/pupdevices: add ColorSensor 
Initial class without any methods for the SPIKE Color Sensor
 2020-05-27 13:58:30 +02:00
Laurens Valk 5e921680ab doc/hubs: add Move Hub motor default directions 2020-04-08 11:09:30 +02:00
Laurens Valk 95e808df9d doc/pupdevices: add sensor icons 
Only the ColorDistanceSensor is added to the docs for now. Other icons are included for future use.
 2020-03-25 20:30:34 +01:00
Laurens Valk 3b61cc81d2 doc/pupdevices: dc motors with default directions 2020-03-25 20:30:33 +01:00
Laurens Valk 73a41beeb4 doc/pupdevices: add motors with default directions 2020-03-25 20:27:51 +01:00
David Lechner 87c2b6857f api: Use leading _ to hide internals in intellisense 
Intellisense in VS Code (both jedi and ms python language server) picks
up all imported names and suggests them with equal priority for
code completion. By adding a leading underscore, intellisense lists
these with a lower priority, so they don't get in the way.

Also rename from builtins to _common while we are touching this to
better reflect the intention of the module (it contains types shared
by multiple modules, not builtin types like int).
 2020-03-25 20:24:32 +01:00
Laurens Valk a827491b2b doc/pupdevices: doc ColorDistanceSensor.remote() 2020-03-20 11:13:52 +01:00
Laurens Valk 1158e4e45a api/builtins/Motor: separate methods for stop 
stop(Stop.COAST)
stop(Stop.BRAKE)
stop(Stop.HOLD)

becomes

stop()
brake()
hold()

This is easier to type and remember.
 2020-03-17 15:19:55 +01:00
David Lechner abe24cf289 api/builtin: add missing DCMotor.stop() method 
This was missing. It also has a different default value
from the Motor class, so Motor overrides this method.
 2020-03-12 12:52:27 -05:00
Laurens Valk a0fba6c2d1 api/builtins/Control: Move stalled to control 
This is a control status property, so move it to the control class. This way, it is hidden from the common motor methods, and DriveBases will be able to use it too.
 2020-02-17 13:55:45 +01:00
Laurens Valk 71ae6825a0 doc/pupdevices: hide non-implemented device/method 2020-01-28 20:12:19 +01:00
Laurens Valk 6278aeb1b6 doc/builtins: drop simplemotor 
Now that we have reduced the complexity of the docstrings and after moving the control settings to a separate page, it is no longer necessary to have simplified motor docs.
 2020-01-28 17:51:23 +01:00
Laurens Valk fe39782b5a config: rename _instances 
Now that the instance hack has been dropped, all that remains is the simplified motor docs, so rename file accordingly.
 2020-01-14 17:58:10 +01:00
Laurens Valk 02d64775af doc/*/button: update to double colon reference 
This lets us drop the instances hack
 2020-01-14 17:37:07 +01:00
Laurens Valk b578693422 doc/*/light: update to double colon reference 
This lets us drop the instances hack
 2020-01-14 17:34:04 +01:00
David Lechner 31a639f55b doc/api/conf.py: enable nitpicky 
This enables the sphinx doc nitpicky option to detect broken references.

Also fix all of the broken references.
 2020-01-11 21:08:20 -06:00
Laurens Valk e74003f5d8 doc/customdevices: add DCMotor 2020-01-01 16:31:19 +01:00
Laurens Valk 46dba95342 api/builtins: add DCMotor 
This is a strict subset of Motor, covering functionality of DC motors only. This is useful for motors without encoders, such as train motors.

It is inherited by Motor, which adds functionality that requires encoders.
 2020-01-01 13:18:41 +01:00
Laurens Valk 8acab1898a doc: delete existing inline examples 
Those should be included as working and tested Python files instead. They should be toggled on/off.
 2019-12-09 14:31:53 +01:00
Laurens Valk 2e78033720 doc/devices: simplify motor docs, reduce detail 
Previously, we simplified the docs for initializing a motor. This commit also simplifies the docstrings for common motor methods, by leaving out details and optional arguments. Full details are still available on the dedicated motor page.
 2019-12-09 11:09:11 +01:00
Laurens Valk ada319f88d doc/pupdevices: drop gears example 
This is reserved for the detailed Motor page.
 2019-11-11 13:30:08 +01:00
Laurens Valk f12c579159 doc: move Motor to dedicated page. 
Instead, show shorter, simpler Motor docs platform-devices pages. For the moment, this just means deleting the advanced methods section from those pages, but we may choose to simplify further.

This change makes it easier to navigate the ev3devices/pupdevices pages because the motor sections aren't overly long.

Details will still be available on the Motor pages for those who wish to use the more advanced motor capabilities such as adjusting the PID settings.
 2019-11-11 13:22:08 +01:00
Laurens Valk 5c832498b6 doc: motors match module 2019-10-19 21:38:33 +02:00
Laurens Valk 2ec5b0aab9 doc: organize motors 2019-10-18 18:32:09 +02:00
Laurens Valk 372e5ccbd0 doc: single api target 
Also delete getting started instructions
 2019-10-18 18:11:57 +02:00