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
425 Commits 10 Branches 125 Tags
aa343d017f5c003fa67a9b58bcf228659cd34f18
Commit Graph
164 Commits
Author SHA1 Message Date
Laurens Valk aa343d017f doc/robotics: add note for when to change settings 2020-03-17 15:47:54 +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
Laurens Valk 1c576d5b11 api/builtins/Motor: rename stop_type kwarg 
All point-to-point maneuvers come to a controlled stop before the stop
mode kicks in. Therefore it is more accurate to rename stop_type to
then, as this argument controls what happens after stopping,
so it reads: then=Stop.HOLD.
 2020-03-17 15:19:27 +01:00
Laurens Valk 65888a825d api/robotics: revert stop type for stop() 
Partially reverts b25227ec5b

This stays coast by default. This way, stop() remains the best way to release all torque from a motor. Also, it ensures that stopping a running motor or drivebase is smooth by default.
 2020-03-15 20:44:21 +01:00
Laurens Valk d282d38836 doc/builtins/DCMotor: a DCMotor cannot hold 2020-03-15 20:36:38 +01:00
Laurens Valk 9dd1f45ccd doc: drop default argument in docstring 
This is visible in the function definition, so no need to repeat it.
 2020-03-15 20:35:36 +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
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
David Lechner b25227ec5b api/Motor,DriveBase: change default stop to HOLD 
This reflects a change in the implmentation
 2020-03-07 16:24:42 -06:00
David Lechner cab16f6af7 api/media/ev3dev: add Image/screen save method 
This was overlooked previously.
 2020-03-06 12:59:42 -06: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 10731d019a doc/parameters: remove Align 
This was already hidden from the docs, but not deleted.
 2020-03-03 17:43:53 +01:00
Laurens Valk c02cc456f7 api/iodevices/Ev3devSensor: add device index 
This makes it easy to find the sensor to access additional features through the ev3dev lego-sensor and lego-port classes.
 2020-02-25 10:29:40 +01:00
David Lechner df6cfa30f6 api/media.ev3dev.Image: Add default args for empty() 
Implementation has been changed so that omitting args gives an empty
image the same size as the screen.
 2020-02-21 11:01:44 -06:00
Laurens Valk 854760feb6 api/builtins/Control: add feed_forward gain 
This can be useful for motors with high internal static friction.
 2020-02-20 16:34:25 +01:00
Laurens Valk 0d068b17f2 api/iodevices/AnalogSensor: remove type check 
This makes it consistent with the UARTDevice and I2CDevice class.

The `Ev3devSensor` class can be used instead if auto id is desired.
 2020-02-20 16:23:26 +01:00
Laurens Valk b81b28d338 api/builtins/Control: add scale property 2020-02-19 19:40:44 +01:00
Laurens Valk 16e8af0f4d api/builtins/Control: add integral_rate setter 2020-02-17 14:04:50 +01: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 9db7e95959 api/robotics: DriveBase: rename settings args 
Make it explicit that these arguments affect only the settings for the corresponding methods.

Also rephrase a few docstrings to make them easier to read or fix typos.
 2020-02-17 13:43:48 +01:00
David Lechner 5231c48eda pybricks/media/ev3dev: list known font language codes 
This list was obtained by running fc-list on an EV3.
 2020-02-15 18:18:36 -06:00
Laurens Valk 9c6d2267bd api/nxtdevices/ColorSensor: add rgb and light 
also, remove detection of brown color, because this is not supported
 2020-02-14 19:26:05 +01:00
Laurens Valk 3c2f1b8444 doc/builtins: update to remove brightness 
This setting has previously been removed but the docstring was not updated.
 2020-02-14 19:24:55 +01:00
Laurens Valk 0ea4c22670 api/tools: add DataLog 2020-02-14 11:47:43 +01:00
Laurens Valk 250dfc63b5 api/tools: remove print 
Going forward, we are using the builtin print function.
 2020-02-13 17:56:11 +01:00
David Lechner 279b0a2a7e dock/messaging: remove TODO about using Bluetooth address 
This has been fixed, so we can remove the TODO.
 2020-02-12 15:56:03 -06:00
Laurens Valk 57a44265b8 api/nxtdevices: add VernierAdapter 2020-02-12 12:49:40 +01:00
Laurens Valk d1a9d6f15f doc/messaging: drop availability 
This appears to give build errors in derivatives of this repository, so we remove it for now.
 2020-02-12 11:20:22 +01:00
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 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 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 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