Laurens Valk
5c2df91bc4
doc/iodevices: split ev3 and pup to subfiles
...
This allows us to easily exclude a platform if needed.
2020-01-09 22:02:33 +01:00
Laurens Valk
09d453480b
api/robotics: add DriveBase state getters
2020-01-02 16:51:50 +01:00
Laurens Valk
3d9a6f11cc
api/robotics: add DriveBase draft
...
This is a concept for a DriveBase class for common robot tasks.
2020-01-02 16:36:37 +01:00
Laurens Valk
af3954989a
doc/iodevices: add note about EV3 compatibility.
...
Some iodevices are only available on EV3 (for now or forever).
2020-01-02 16:02:10 +01:00
Laurens Valk
f73e7f08bc
api/iodevices: add LUMPDevice
...
This can be used to interface with LPF2 and EV3 sensors that use the LEGO UART Messaging Protocol.
2020-01-02 15:53:44 +01:00
Laurens Valk
21a0b8766e
api: rename customdevices to iodevices
...
These devices are not always custom. Rather, the classes in this module are very generic and apply to a wide range of input/output devices.
2020-01-01 16:41:29 +01: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
e183f73d4e
doc/customdevices: replace example by include
...
This makes examples more maintainable.
2019-12-10 15:34:41 +01:00
Laurens Valk
d975974d07
snippets: add uart example
2019-12-10 13:29:41 +01:00
Laurens Valk
2e530a4b30
doc/hubs: toggle example snippet
...
This shows how to add and include an example project as a snippet.
2019-12-10 09:28:08 +01:00
Laurens Valk
61bfd359f1
doc: remove example projects
...
Full project examples are not included in the API.
2019-12-09 16:53:12 +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
893b23ce90
api/builtins/Speaker: add speech
2019-12-09 14:15:43 +01:00
Laurens Valk
be1522ad04
api/builtins: Update speaker API
...
- Volume is a setting.
- Remove beeps method. To do multiple beeps, users can make their own loop.
- Rename file to play.
2019-12-09 13:13:06 +01:00
Laurens Valk
3afaa83ba0
doc/hubs: add note to say screen not implemented
...
This will be unhidden/updated later.
2019-12-09 13:00:59 +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
709659ffbf
doc/hubs: remove builtins section
...
This will not be used in the next release.
2019-12-09 10:43:28 +01:00
Laurens Valk
be667caa7b
doc/signaltypes: move scalars and vectors
...
This makes it possible to exclude this information from releases that do not use it.
2019-12-09 10:31:22 +01:00
Laurens Valk
e7c63533b0
doc/parameters: remove unused parameters
...
Ports are accessed through hub instance.
The Axis and Side parameters will not be implemented for the next release, so we remove them for now.
2019-12-09 10:21:36 +01:00
Laurens Valk
22bbca3e24
doc/customdevices: simplify I2C docs
...
remove smbus information, point to source code instead.
2019-12-06 15:16:06 +01:00
Laurens Valk
1187f059fa
api/customdevices: add UARTDevice
2019-12-06 14:57:43 +01:00
Laurens Valk
e6a1ae78ca
doc+api/customdevices: add I2CDevice
2019-11-14 12:56:53 +01:00
Laurens Valk
653aa669b2
doc+api/customdevices: move AnalogSensor
...
Generic and custom devices like the AnalogSensor will live in a dedicated module.
2019-11-14 08:47:30 +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
d172780508
doc/motors: add stalled section
...
By moving some of the technical details to dedicated sections of the docs, we can add more (or simplified, less technical) information without cluttering the API commands.
2019-11-11 15:08:08 +01:00
Laurens Valk
d6f25acce8
doc/motors: add gears section
...
Explain the setting using an example.
2019-11-11 14:50:30 +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
4f25a0c467
doc/ev3devices: On EV3 docs, drop DC methods.
...
These can still be viewed on the full Motor class description. But on EV3, these functions are not so relevant as all motors have encoders.
Then we can also remove the encoded/encoderless rubric, further removing clutter.
2019-11-11 13:25:41 +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
f73e10b99b
api: add EV3 Analog Sensor
2019-11-04 16:58:30 +01:00
Laurens Valk
15f5626948
doc: document new media submodule
2019-11-04 16:58:22 +01:00
Laurens Valk
5c832498b6
doc: motors match module
2019-10-19 21:38:33 +02:00
Laurens Valk
2307a20cf0
doc: simplify module toc
2019-10-19 21:18:59 +02:00
Laurens Valk
a9f3b2a556
doc: clean up City Hub and Move Hub
2019-10-19 20:25:47 +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
Laurens Valk