Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 09:37:25 +00:00
Code Issues Releases Activity
353 Commits 10 Branches 125 Tags
6337b6c4516a6004ccf890be04ecf05caa9516f5
Commit Graph
120 Commits
Author SHA1 Message Date
Laurens Valk 6337b6c451 api/iodevices: Separate Ev3devSensor class 
This is not just an alias for a LUMPDevice because it works differently. On ev3dev, sensor modes are set using strings.

Also, simplify the introductory text and reasons for using it.
 2020-02-03 13:54:18 +01:00
Laurens Valk 2bd149a121 doc/iodevices: reorganize TOC 
Make the heading levels match the module. No subcategories, but say which devices are available on EV3 only.
 2020-02-03 11:35:43 +01:00
Laurens Valk 3e5f552591 api/iodevices: update i2c doc and sample 
Reflect that we read one byte by default.

By popular request, also allow a second way to send one byte, by specifying a register with no data.
 2020-02-03 10:37:32 +01:00
Laurens Valk ab6b15f047 doc/media: toggle items by category 
Make it easier to browse the options.
 2020-01-29 14:47:03 +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 4ed787240e api/builtins: drop motor setting setters 
this will be done through the control attribute instead
 2020-01-28 17:53:11 +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 1ba961b29c doc/builtins: simplify motor docs 
Reduce unnecessary details for motor methods
 2020-01-28 17:41:36 +01:00
Laurens Valk 36a393c927 api/builtins/Control: introduce Control class 
This is a generic class to interact with PID Controllers. A Motor has one control instance (for angle) and a drivebase will have two (one for heading, one for distance).

This will replace the motor specific settings
 2020-01-28 16:25:53 +01:00
Laurens Valk 4faa5d3df8 doc/hubs.EV3Brick: toggle note specs 
This condenses long lists that are not frequently used.
 2020-01-27 13:25:42 +01:00
Laurens Valk 167cf3ad18 doc/builtins/Speaker: use '' for string settings 
Also simplify by not listing all the options twice, and follow style for default argument.
 2020-01-27 13:12:57 +01:00
Laurens Valk aac25bb050 doc/media/ev3dev: fix ' in docstring 
Also update todo note.
 2020-01-27 13:07:51 +01:00
Laurens Valk 08e63e69ca api/builtins/DCMotor: drop settings 
These settings are control properties, so they cannot be altered on DC Motors.
 2020-01-27 12:56:47 +01:00
Laurens Valk 1c801f1520 api/robotics: add tank method 
Also, group similar methods together and explain what they do.
 2020-01-27 11:20:07 +01:00
Laurens Valk dd39a2e00f api/robotics: update DriveBase API 
Make arc a non-blocking function similar to drive. This allows users to drive the robot along an arc until a sensor (e.g. color) is triggered, instead of relying on the rotation sensors only.

This also lets us simplify the language of some other method docstrings.
 2020-01-23 17:58:24 +01:00
Laurens Valk 00f5b9e13b doc/screen: simplify print doc 
Only say what it does, not what it doesn't do.

Also delete "on the image" because this is also used for the screen.
 2020-01-16 13:48:56 +01:00
Laurens Valk f7ff1e511e api/builtins/ColorLight: remove brightness 
Brightness control will not be implemented for the next release, so remove it.
 2020-01-16 13:34:18 +01:00
Laurens Valk 90314b3f49 api/ev3.speaker: Fix missing language arg 
This was added to the docstring but not the method.
 2020-01-16 13:31:04 +01:00
Laurens Valk b6f75eca9c config: ignore literals by regexp and config files 
No need to have all of them in the ignore list now.
 2020-01-16 13:28:09 +01:00
Laurens Valk 834a2173b4 doc/builtins: fix typos 2020-01-16 11:40:34 +01:00
Laurens Valk 50a9d36314 api/ev3.speaker: separate language and voice settings 2020-01-16 11:25:13 +01:00
Laurens Valk 8904413084 doc/speaker: Put language under show/hide toggle 
This list is rather long, so hide it by default.
 2020-01-16 10:34:56 +01:00
Laurens Valk 7a16c637aa doc/speaker: fix typo 2020-01-16 10:27:31 +01:00
David Lechner dc82ccce40 resources renamed to media.ev3dev 2020-01-14 17:32:40 -06:00
Laurens Valk a6e6de28b5 api/nxtdevices: update sound audible argument 
rename to audible_only for a more precise description.
 2020-01-14 21:27:01 +01:00
Laurens Valk 5a0dc278d0 api/nxtdevices: add Energy Meter 2020-01-14 20:17:43 +01:00
Laurens Valk b1cb062c7c api/nxtdevices: add Temperature Sensor 2020-01-14 20:16:40 +01:00
Laurens Valk aed3823af1 api/nxtdevices: add Sound Sensor 2020-01-14 20:16:10 +01:00
Laurens Valk 7b7b69a141 api/nxtdevices: add Ultrasonic Sensor 2020-01-14 20:15:29 +01:00
Laurens Valk 23b8700773 api/nxtdevices: add Color Sensor 2020-01-14 20:14:56 +01:00
Laurens Valk 7f3ac46558 api/nxtdevices: add Light Sensor 2020-01-14 20:13:23 +01:00
Laurens Valk 19e4d3d36f api/nxtdevices: add Touch Sensor 2020-01-14 20:12:27 +01:00
Laurens Valk ad12d13355 api/nxtdevices: add module 2020-01-14 20:10:33 +01:00
Laurens Valk 46de4b73ca doc/ev3devices: drop millimeters note 
This is already shown as the return type, so this is a duplicate.
 2020-01-14 19:38:59 +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 6875e6ff42 config: drop _instances for methods 
This is no longer needed with the double colon reference to link to class instances.
 2020-01-14 17:47:47 +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
Laurens Valk 6371ebb870 doc/battery: update to double colon reference 
This lets us drop the instances hack
 2020-01-14 17:15:41 +01:00
David Lechner 9c024e17c4 pybricks/builtins: update speaker methods 
Update Speaker class with newly implemented methods
 2020-01-13 20:14:49 -06:00
David Lechner 0398d04af9 pybricks/resources/image: add show_image() method 2020-01-13 20:12:50 -06:00
David Lechner c3e74273d2 pybricks/builtins: update Speaker docs 2020-01-13 12:59:21 -06:00
David Lechner ee0819adef pybricks/builtins: remove deprecated Display class 
The Display class is from Pybricks MicroPython 1.0 and has been
replaced by the Image class.
 2020-01-13 12:59:07 -06:00
David Lechner b4cd9113b5 doc/api/hubs_ev3brick: add Image class as EV3Brick.screen 
This duplicates the Image class documentation In pybricks.ev3devices
as EV3Bricks.screen.
 2020-01-13 12:59:07 -06:00
David Lechner f694de2277 pbyricks/resources: new Image and Font classes 
This adds API and documentation for the pybricks.resources module
Image and Font classes.
 2020-01-13 12:59:07 -06:00
Laurens Valk 220ad471b8 api/ev3devices: remove duplicate AnalogSensor 
This has previously been moved to the iodevices class
 2020-01-13 13:30:08 +01:00
Laurens Valk e244f28ddb api/builtins: drop method string override 
We had these because enums expanded to numeric values. Because we now have an alternate enum implementation, we don't need these strings anymore.
 2020-01-13 12:19:59 +01:00
David Lechner 1b426b90f7 pybricks/parameters: introduce _PybricksEnum class 
This adds a _PybricksEnum base class for all enums. In Pybricks
MicroPython, we don't have an Enum class, but rather just simple
lookup tables.

The __repr__() method prints the enum values like the Pybricks
MicroPython implementation and also causes sphinx doc to correctly
print the value when used as a default value for aguments.

The __dir__() method is overloaded for both the instance and the class
to match what is seen in Pybricks MicroPython. This should help hide
things from code Python completion that are not present in MicroPython.
 2020-01-11 21:08:24 -06:00