Commit Graph
324 Commits
Author SHA1 Message Date
Laurens Valk 4e2aec6c35 doc/pupdevices/motor: split examples
Now that each device is on its own page, we no longer need to collapse snippets to reduce page size. Now they can just all be at the bottom of the page. This also gives each a dedicated link which is easier when giving support.
2020-12-29 14:35:07 +01:00
Laurens Valk 2375a1abcb doc/pupdevices/colorsensor: split examples
Now that each sensor is on its own page, we no longer need to collapse snippets to reduce page size. Now they can just all be at the bottom of the page. This also gives each a dedicated link which is easier when giving support.
2020-12-29 14:10:41 +01:00
Laurens Valk ab4da63029 doc/hubs: move examples to dedicated sections
Now that each hub is on its own page, we no longer need to collapse snippets to reduce page size. Now they can just all be at the bottom of the page. This also gives each a dedicated link which is easier when giving support.
2020-12-29 13:58:17 +01:00
Laurens Valk ab384b464b doc/pupdevices/colordistancesensor: split examples
Now that each sensor is on its own page, we no longer need to collapse snippets to reduce page size. Now they can just all be at the bottom of the page. This also gives each a dedicated link which is easier when giving support.
2020-12-29 12:08:29 +01:00
Laurens Valk d2de1089d6 doc/hubs/index: clean up thumbnail page 2020-12-29 11:50:55 +01:00
Laurens Valk b76b6cf835 doc/pupdevices: one page per sensor
This page was getting very long, so split it up for easier navigation (#33).
2020-12-29 11:47:27 +01:00
Laurens Valk 84b882f8b8 api/hubs/InventorHub: add speaker instance 2020-12-18 13:35:19 +01:00
Laurens Valk c3fc818037 doc/common/Speaker: move note information back
We were hiding this under a toggle menu to reduce the page size of the hubs module. Now that each hub is on its own page, this is no longer necessary.

In turn, this makes it easier to document the same method for other hubs.
2020-12-18 13:32:18 +01:00
Laurens Valk 57ff8312f3 api/iodevices/PUPDevice: add info() method 2020-12-18 13:20:17 +01:00
Laurens Valk 68511bd3eb doc/iodevices: note on I2C/UART on Powered Up 2020-12-14 10:34:41 +01:00
Laurens Valk ba4fe80b50 doc/iodevices: add PUPDevice class 2020-12-14 10:27:23 +01:00
Laurens Valk b7d728a86e doc/iodevices: move LUMPDevice to EV3 only section
Also update graphic used for this device class.
2020-12-14 10:16:02 +01:00
Laurens Valk 3e322165f5 doc/hubs: include light matrix display examples 2020-11-11 18:57:04 +01:00
Laurens Valk 983562f7b8 doc/hubs/inventorhub: document light, display, buttons 2020-11-06 15:59:02 +01:00
Laurens Valk 1c9d0dd86f api/hubs/PrimeHub: enable buttons 2020-11-06 15:55:48 +01:00
Laurens Valk e92fd1f05b doc/hubs/primehub: align button and display 2020-11-06 12:45:49 +01:00
Laurens Valk 9a45c6582c doc/hubs/PrimeHub: add labeled diagrams 2020-11-06 12:38:03 +01:00
Laurens Valk 3e3af62713 doc/start_ev3: drop absolute path reference 2020-11-06 12:33:21 +01:00
Laurens Valk c93875729a doc/hubs/PrimeHub: add hub diagrams
document lights, row/col index, buttons
2020-11-06 12:32:45 +01:00
Laurens Valk 3288591cc3 doc/parameters: Add ports E, F 2020-11-06 12:31:42 +01:00
Laurens Valk 8f21cea345 api/common: clean up Light Matrix
This renames the generic class from LightGrid to LightMatrix. The instance object is simply called display.

This makes user scripts easier to type and read.

This also cleans up most of the draft docstrings for this class and fixes a few argument typos.
2020-11-06 12:31:42 +01:00
Laurens Valk 4e9886dba8 api/geometry: add new module
This module will contain mathematical tools to deal with geometry and motion of robots. This includes a Matrix type for common matrix operations.
2020-11-06 12:31:42 +01:00
Laurens Valk 17b1151490 doc/parameters/Side: clarify sides for screens 2020-11-06 12:31:42 +01:00
Laurens Valk 6083992914 doc/parameters: add diagrams to designate sides
This adds labeled images for each hub/sensor for which the side is relevant, so that there can be no confusion over which is the left/right, top/bottom, or front/back side.
2020-11-06 12:31:38 +01:00
Laurens Valk 70ed79076d api/parameters: add Side enum
This will be used to designate orientations of hubs/sensors/screens.
2020-11-04 10:19:35 +01:00
Laurens Valk 31f2e9b071 examples: update paths in docs 2020-11-04 10:17:33 +01:00
Laurens Valk 429d5d4d0d doc/pupdevices: add gray large angular motor 2020-10-26 10:17:32 +01:00
Laurens Valk 7b23db5abd doc/start_pup: update outdated notes
The stable version of Google Chrome has the required BLE support, so we can remove the steps about the beta version.

Also update the note on Boost beta and light status.
2020-10-25 21:49:26 +01:00
Laurens Valk 5c8809f542 doc/start_pup: add powered up hubs image
Make it easier to see which hubs we support.
2020-10-25 21:42:13 +01:00
Laurens Valk 9bcbfd2512 doc/primehub: note to clarify classes are the same 2020-10-25 21:34:05 +01:00
Laurens Valk 1e7991f68d doc/inventorhub: expose hub in the docs 2020-10-25 21:31:05 +01:00
Laurens Valk b29dab4d6b doc/start_ev3: add link to stable 2.0 docs 2020-10-25 21:00:54 +01:00
Laurens Valk d2a5cb2d60 doc/hubs: make visual table of contents 2020-10-25 20:51:56 +01:00
Laurens Valk 7b090d56d8 doc/hubs: move hubs to dedicated pages
The hubs module page was getting too long, leading to much scrolling.
2020-10-25 20:37:51 +01:00
Laurens Valk bcf610a29e doc/index: regroup hubs by platform
Make it easier to pick the right installation guide.
2020-10-25 19:51:40 +01:00
Laurens Valk 55001644d2 doc/start_inventor: add placeholder quick start
This adds an empty page so we can link to it from the main page.
2020-10-25 19:49:18 +01:00
Laurens Valk d4c44a292c api: add PrimeHub 2020-10-09 22:50:49 +02:00
Laurens Valk 90bea73c11 doc/hubs: Add light examples 2020-10-09 22:46:35 +02:00
Laurens Valk a603c19d0e doc/hubs: expose color light functionality
This enables the blink and animate methods.

The examples are not yet included.
2020-10-09 19:58:35 +02:00
Laurens Valk 1b730836e4 api/pupdevices/Light: drop blink, animate
External single-color lights won't have this for now.
2020-10-09 19:58:35 +02:00
Laurens Valk ede503f6fe config: rename CPlusHub to TechnicHub
This replaces the name in internal files.
2020-10-09 19:16:33 +02:00
Laurens Valk 24d35993e9 api: rename CPlusHub to TechnicHub
This reflects the newly adopted naming convention.

See https://github.com/pybricks/support/issues/119
2020-10-09 19:16:33 +02:00
Laurens Valk d6651fc3c5 api/pupdevices: replace color_map
This reclects the implementation update that changes how
color sensing is performed and interfaced with by the user.
2020-10-08 20:19:33 +02:00
Laurens Valk 6671e3def0 pybricks-projects: update color sensing examples 2020-10-08 19:25:04 +02:00
Laurens Valk 4319b2fad8 api/common/Light: add blink and animate 2020-08-25 13:38:09 +02:00
Laurens Valk c6c14afca2 doc/parameters/Color: add colors to each class atribute
This makes it much easier to pick the right color.
2020-08-12 12:22:14 +02:00
Laurens Valk 282e34b9e0 config: add pybricks-color directive
This directive produces a small box with the color from the Pybricks API:

.. pybricks-color:: CYAN
2020-08-12 12:19:49 +02:00
Laurens Valk 1eb75e24e7 api/parameters/Color: generalize color type
First step towards making a color type with HSV representation.

Colors such as Color.RED or Color.BLUE continue to exist, but now you
can also define your own colors:

DARK_RED = Color(h=0, s=100, v=50)
2020-08-12 12:18:24 +02:00
Laurens Valk be8592f096 doc/pupdevices/PFMotor: Documentation and examples 2020-08-11 12:13:06 +02:00
Laurens Valk 4d88fbbbd2 api/pupdevices/PFMotor: DCMotor functionality
This replaces the on-off method in ColorDistanceSensor.remote()
with a PFMotor class that works just like the DCMotor class. This
provides much more functionality without having to invent a new API.
2020-08-11 12:05:53 +02:00