Laurens Valk
3488e1fb83
doc/pupdevices/UltrasonicSensor: document invalid
...
Document how invalid values are reported.
2020-07-10 12:32:52 +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
8a43dc936a
doc/signaltypes: add hue placeholder
...
We will have to add a helpful diagram, but having the placeholder allows us to link to it already.
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
80840396aa
api/pupdevices: add Powered Up Light
2020-06-08 15:26:19 +02:00
Laurens Valk
ce993900d1
api/pupdevices: update illuminate argument
...
match the implementation and simplify description
2020-05-27 13:58:30 +02:00
Laurens Valk
f604dd321e
api/pupdevices/UltrasonicSensor: drop silent
...
Like its EV3 counterpart, this does not work reliably enough, so remove.
2020-05-27 13:58:30 +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
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
2d3e85f531
api/_common.LightArray: merge on and array method
...
Make it simpler with only one method to turn the lights on.
2020-05-27 13:58:30 +02:00
Laurens Valk
4de436e479
doc/motors: hide extra sections until ready
...
Avoid references to non-existing explanations.
2020-04-24 12:00:26 +02: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
ada50328bb
doc/pupdevices/Motor: fix reset_angle
...
The note about absolute angle support had accidentally ended up in the GyroSensor. It applies only to pupdevices.Motor.
2020-03-24 16:25:06 +01:00
Laurens Valk
0bee7ef984
doc: fix and clarify verbs
2020-03-24 12:12:49 +01:00
David Lechner
166ce2109f
doc: Use verbs ending in s for functions/methods
...
The documentation currently has a mix of with and without the `s`.
Adding an `s` is consistent with most API documentation in general,
especially more modern documentation.
2020-03-24 12:11:53 +01:00
Laurens Valk
a827491b2b
doc/pupdevices: doc ColorDistanceSensor.remote()
2020-03-20 11:13:52 +01:00
Laurens Valk
661de5f0fe
doc/*devices: improve rgb() docstring
2020-03-20 10:42:52 +01:00
David Lechner
6ed6ec0378
api: remove empty () on class declarations
...
Python allows this syntax and some even consider it good style.
2020-03-12 12:46:09 -05:00
Laurens Valk
066983a5e1
LICENSE: Update year and authors
...
Also add SPDX-License-Identifier: MIT to API source files for clarity.
2020-03-05 10:33:48 +01:00
Laurens Valk
c55556a598
config: ignore unused import
...
These are not used by classes in the docs, but they are used by Sphinx.
Also, this will be used to let autocomplete know that these modules contain a Motor class.
2020-01-28 18:03:18 +01:00
Laurens Valk
9a3d4f88b6
doc/ev3devices, pupdevices: drop catalog id
...
This will be replaced with a render of the device, included by the RST file, not the docstring.
2020-01-28 18:00:55 +01:00
Laurens Valk
e73945d9c5
doc/ev3devices, pupdevices: do not inherit Motor
...
Just import it. Otherwise, Sphinx does not pick up autoattribute docstrings.
2020-01-28 17:58:54 +01:00
Laurens Valk
1ba961b29c
doc/builtins: simplify motor docs
...
Reduce unnecessary details for motor methods
2020-01-28 17:41:36 +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
Laurens Valk
69216abc8a
api/pupdevices: fix line break
...
This caused the init arguments to be displayed incorrectly.
Also, fix whitespaces and line ends.
2019-11-11 15:13:13 +01: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