Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity
371 Commits 10 Branches 125 Tags
aded6ebfe7a6b71470b5ecc69c81ff8ffcbe257e
Commit Graph
371 Commits
This Branch
This Branch
All Branches
Author SHA1 Message Date
David Lechner aded6ebfe7 doc/messaging: clarify incoming and outgoing 2020-02-12 09:55:28 +01:00
David Lechner f8ccbb7896 api/messaging: rename ev3messaging module to messaging 2020-02-12 09:55:28 +01:00
Laurens Valk 37a297cf0d doc/ev3messaging: add draft network diagram 2020-02-12 09:55:28 +01:00
Laurens Valk 627701d26a doc/ev3messaging: organize page 
Group connection related classes under a header and move it to the top.

Avoid duplicating shared methods. This reduces the page length considerably so it is easier to see the bigger picture. Add examples of data types instead.
 2020-02-12 09:55:28 +01:00
Laurens Valk 57c53921ec api/ev3messaging: don't encode by default 
The Numeric/Text/Logic will be the convenience classes for common data types, so make the basic class general purpose for sending bytes.
 2020-02-12 09:55:28 +01:00
David Lechner b1382f02b0 move EV3 mailboxes to ev3messaging module 
- add separate maibox classes
- drop bluetooth module since it is not considered public API
 2020-02-12 09:55:28 +01:00
David Lechner 7acbcbd874 initial EV3 bluetooth mailbox docs 2020-02-12 09:55:28 +01:00
David Lechner f16876cca9 doc/media/ev3dev/image: use substitution to disambiguate screen/image 2020-02-11 11:49:05 -06:00
David Lechner d9089bcbae api/media/ev3dev: update for Image API changes 2020-02-11 11:43:54 -06:00
Laurens Valk 0841899394 api/builtins/Control: expose done method 
This was added but not yet exposed
 2020-02-10 15:57:23 +01:00
Laurens Valk 37de307ef0 doc/motors: add note about controller inactivity 2020-02-09 23:47:35 +01:00
Laurens Valk 4a8912ff99 api/builtins/Control: add done method 
This can be used to check if a maneuver is done yet
 2020-02-09 23:39:59 +01:00
Laurens Valk bdca322cef api/builtins/Control: add integral_range setter 2020-02-09 23:39:16 +01:00
Laurens Valk 477c913ec2 api/robotics/DriveBase: drop stop_type setter 
Point to point commands will always hold. The stop method can be used to enforce other stop types.
 2020-02-09 23:31:18 +01:00
Laurens Valk f5c3347ba1 doc/signaltypes: fix label 
This was left behind when grouping labels earlier
 2020-02-07 20:13:35 +01:00
Laurens Valk ceeea92d98 doc/builtins: fix order of arguments 2020-02-07 20:10:35 +01:00
Laurens Valk f1f1ceaac9 api/robotics/DriveBase: add state getter 2020-02-06 14:05:14 +01:00
Laurens Valk 7423161615 api/robotics: simplify API 
drop methods that will not be implemented for next release and simplify descriptions of methods that will be implemented.
 2020-02-05 16:55:03 +01:00
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 e97423da72 doc/motors: hide status getters 
These are not yet implemented
 2020-01-29 13:38:32 +01:00
Laurens Valk 741af5280a config: ignore only generated images 
Make sure we can add other images without doing special things.
 2020-01-29 12:57:03 +01:00
Laurens Valk d923f79506 doc/motor: reduce width of commented text 2020-01-28 20:30:42 +01:00
Laurens Valk 6525fbc98a doc/frames: hide page 
This won't be needed until support for accelerometers is added.
 2020-01-28 20:28:29 +01:00
Laurens Valk f3003720ee doc/parameters: hide unused parameters 
There is no functionality in the release that uses this yet.
 2020-01-28 20:23:55 +01:00
Laurens Valk 5363ff5015 doc/motors: hide unfinished sections 
make it easier to see what is ready for review
 2020-01-28 20:23:01 +01:00
Laurens Valk 71ae6825a0 doc/pupdevices: hide non-implemented device/method 2020-01-28 20:12:19 +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 2bb1fe2cb7 doc/motors: move Control class to dedicated place. 
This way the DriveBase can refer to it too.
 2020-01-28 17:09:21 +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 4bff13b5ca doc: drop separate sound page 
The sound is not independently useable, and it is already documented for the speaker.
 2020-01-27 13:03:41 +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 a029757b4a doc/robotics: hide non-implemented methods 2020-01-27 12:51:48 +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 f5094cfaba config: use inline math and common characters 
Latex errors cannot be parsed by humans, so just use inline math which we had working elsewhere already.

Also use simplified character for ế, for latex compatibility.
 2020-01-16 15:03:54 +01:00
Laurens Valk 686a3b8147 doc/media: update to say that these are ev3dev media 2020-01-16 14:31:14 +01:00
Laurens Valk 09a2e3eed9 doc/media/ev3dev: move files back to top 
These are the most used. Also add separate heading for images/sounds so they can easily be found through menu.

Also lower currently mixed case rubric titles.

It would still be nice to make these lists shorter, perhaps using a dropdown or table.
 2020-01-16 14:30:23 +01:00
Laurens Valk 022f15a437 config/spelling: ignore literals, data directives 2020-01-16 14:22:21 +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