diff --git a/doc/common/extensions/requirements-static.py b/doc/common/extensions/requirements-static.py index 4ed161d..fbb7e4a 100644 --- a/doc/common/extensions/requirements-static.py +++ b/doc/common/extensions/requirements-static.py @@ -17,35 +17,44 @@ FEATURES_MEDIUM = FEATURES_SMALL | { "pybricks-frozen", } -# Large feature set. -FEATURES_LARGE = FEATURES_MEDIUM | { - "ble-extra", # Extra features such as pairing or multiple connections. -} - # Features per hub. HUB_FEATURES = { - "movehub": {"movehub", "pup"} | FEATURES_SMALL, - "cityhub": {"cityhub", "pup"} | FEATURES_MEDIUM, - "technichub": {"technichub", "gyro", "xbox-controller", "pup"} | FEATURES_MEDIUM, + "movehub": {"movehub", "ble", "pupdevices"} | FEATURES_SMALL, + "cityhub": {"cityhub", "ble", "pupdevices"} | FEATURES_MEDIUM, + "technichub": {"technichub", "gyro", "xbox-controller", "ble", "pupdevices"} + | FEATURES_MEDIUM, "primehub": { "primehub", "inventorhub", "light-matrix", "gyro", "xbox-controller", - "pup", + "ble", + "ble-extra", + "pupdevices", } - | FEATURES_LARGE, + | FEATURES_MEDIUM, "inventorhub": { "primehub", "inventorhub", "light-matrix", "gyro", "xbox-controller", - "pup", + "ble", + "ble-extra", + "pupdevices", } - | FEATURES_LARGE, - "essentialhub": {"essentialhub", "gyro", "xbox-controller", "pup"} | FEATURES_LARGE, + | FEATURES_MEDIUM, + "essentialhub": { + "essentialhub", + "gyro", + "xbox-controller", + "ble", + "ble-extra", + "pupdevices", + } + | FEATURES_MEDIUM, + "ev3brick": {"ev3devices", "nxtdevices", "image"} | FEATURES_MEDIUM, } diff --git a/doc/main/diagrams/compat_ev3brick.png b/doc/main/diagrams/compat_ev3brick.png new file mode 100644 index 0000000..155954e Binary files /dev/null and b/doc/main/diagrams/compat_ev3brick.png differ diff --git a/doc/main/diagrams/compat_nxtbrick.png b/doc/main/diagrams/compat_nxtbrick.png new file mode 100644 index 0000000..45729da Binary files /dev/null and b/doc/main/diagrams/compat_nxtbrick.png differ diff --git a/doc/main/ev3devices/colorsensor.rst b/doc/main/ev3devices/colorsensor.rst index e237060..f5963f4 100644 --- a/doc/main/ev3devices/colorsensor.rst +++ b/doc/main/ev3devices/colorsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: ev3devices Color Sensor ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/ev3devices/gyrosensor.rst b/doc/main/ev3devices/gyrosensor.rst index a00e3a6..a46ea01 100644 --- a/doc/main/ev3devices/gyrosensor.rst +++ b/doc/main/ev3devices/gyrosensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: ev3devices Gyroscopic Sensor ^^^^^^^^^^^^^^^^^ diff --git a/doc/main/ev3devices/index.rst b/doc/main/ev3devices/index.rst index c6bfe85..e49dfc8 100644 --- a/doc/main/ev3devices/index.rst +++ b/doc/main/ev3devices/index.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: ev3devices :mod:`ev3devices ` -- EV3 motors and sensors ================================================================= diff --git a/doc/main/ev3devices/infraredsensor.rst b/doc/main/ev3devices/infraredsensor.rst index 2c8f45a..18d1c1c 100644 --- a/doc/main/ev3devices/infraredsensor.rst +++ b/doc/main/ev3devices/infraredsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: ev3devices Infrared Sensor and Beacon ^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/ev3devices/motor.rst b/doc/main/ev3devices/motor.rst index 936e68c..e8f13df 100644 --- a/doc/main/ev3devices/motor.rst +++ b/doc/main/ev3devices/motor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: ev3devices Motors with rotation sensors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/ev3devices/touchsensor.rst b/doc/main/ev3devices/touchsensor.rst index 628d23a..9859aed 100644 --- a/doc/main/ev3devices/touchsensor.rst +++ b/doc/main/ev3devices/touchsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: ev3devices Touch Sensor ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/ev3devices/ultrasonicsensor.rst b/doc/main/ev3devices/ultrasonicsensor.rst index 1dd4ab0..d832744 100644 --- a/doc/main/ev3devices/ultrasonicsensor.rst +++ b/doc/main/ev3devices/ultrasonicsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: ev3devices Ultrasonic Sensor ^^^^^^^^^^^^^^^^^ diff --git a/doc/main/index.rst b/doc/main/index.rst index 3ca9309..33467c3 100644 --- a/doc/main/index.rst +++ b/doc/main/index.rst @@ -60,12 +60,6 @@ above to reveal this menu. :width: 100 % :target: ev3devices/index.html -.. rubric:: NXT motors and sensors - -.. figure:: ../main/cad/output/nxtdevice-all.png - :width: 100 % - :target: nxtdevices/index.html - .. toctree:: :maxdepth: 1 :caption: Table of contents diff --git a/doc/main/iodevices/index.rst b/doc/main/iodevices/index.rst index a60c7ac..e7709d3 100644 --- a/doc/main/iodevices/index.rst +++ b/doc/main/iodevices/index.rst @@ -41,7 +41,7 @@ LEGO protocol devices :width: 80 % :target: lwp3device.html -.. pybricks-requirements:: ev3 pybricks-iodevices +.. pybricks-requirements:: pybricks-iodevices .. pybricks-classlink:: LUMPDevice @@ -83,7 +83,7 @@ Generic protocols |uart-wired| |uart-wireless| -.. pybricks-requirements:: ev3 pybricks-iodevices +.. pybricks-requirements:: pybricks-iodevices .. pybricks-classlink:: I2CDevice @@ -91,7 +91,7 @@ Generic protocols :width: 20 % :target: i2cdevice.html -.. pybricks-requirements:: ev3 pybricks-iodevices +.. pybricks-requirements:: pybricks-iodevices .. pybricks-classlink:: AnalogSensor @@ -99,7 +99,7 @@ Generic protocols :width: 20 % :target: analogsensor.html -.. pybricks-requirements:: ev3 pybricks-iodevices +.. pybricks-requirements:: pybricks-iodevices .. pybricks-classlink:: DCMotor diff --git a/doc/main/messaging/index.rst b/doc/main/messaging/index.rst index 30a44c4..9005661 100644 --- a/doc/main/messaging/index.rst +++ b/doc/main/messaging/index.rst @@ -4,7 +4,7 @@ .. automodule:: pybricks.messaging :no-members: -.. pybricks-requirements:: pup +.. pybricks-requirements:: ble .. blockimg:: pybricks_variables_set_ble_radio diff --git a/doc/main/nxtdevices/colorsensor.rst b/doc/main/nxtdevices/colorsensor.rst index 4082ba0..0ae9e3c 100644 --- a/doc/main/nxtdevices/colorsensor.rst +++ b/doc/main/nxtdevices/colorsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: nxtdevices NXT Color Sensor ^^^^^^^^^^^^^^^^ diff --git a/doc/main/nxtdevices/energymeter.rst b/doc/main/nxtdevices/energymeter.rst index bc88abc..f5f81a8 100644 --- a/doc/main/nxtdevices/energymeter.rst +++ b/doc/main/nxtdevices/energymeter.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: nxtdevices NXT Energy Meter ^^^^^^^^^^^^^^^^ diff --git a/doc/main/nxtdevices/index.rst b/doc/main/nxtdevices/index.rst index c14bacf..11fdc1b 100644 --- a/doc/main/nxtdevices/index.rst +++ b/doc/main/nxtdevices/index.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: nxtdevices :mod:`nxtdevices ` -- NXT motors and sensors ================================================================= @@ -20,11 +20,11 @@ energymeter vernieradapter -.. pybricks-classlink:: Motor ../pupdevices/motor +.. pybricks-classlink:: Motor ../nxtdevices/motor .. figure:: ../../main/cad/output/ev3device-motors.png :width: 100 % - :target: ../pupdevices/motor.html + :target: ../nxtdevices/motor.html .. pybricks-classlink:: TouchSensor diff --git a/doc/main/nxtdevices/lightsensor.rst b/doc/main/nxtdevices/lightsensor.rst index 2701bdf..959fdfc 100644 --- a/doc/main/nxtdevices/lightsensor.rst +++ b/doc/main/nxtdevices/lightsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: nxtdevices NXT Light Sensor ^^^^^^^^^^^^^^^^ diff --git a/doc/main/nxtdevices/motor.rst b/doc/main/nxtdevices/motor.rst index d826839..349ee02 100644 --- a/doc/main/nxtdevices/motor.rst +++ b/doc/main/nxtdevices/motor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: ev3devices nxtdevices Motors with rotation sensors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/nxtdevices/soundsensor.rst b/doc/main/nxtdevices/soundsensor.rst index e05aef2..33de4dd 100644 --- a/doc/main/nxtdevices/soundsensor.rst +++ b/doc/main/nxtdevices/soundsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: nxtdevices NXT Sound Sensor ^^^^^^^^^^^^^^^^ diff --git a/doc/main/nxtdevices/temperaturesensor.rst b/doc/main/nxtdevices/temperaturesensor.rst index 986c1c4..7c3d96e 100644 --- a/doc/main/nxtdevices/temperaturesensor.rst +++ b/doc/main/nxtdevices/temperaturesensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: nxtdevices NXT Temperature Sensor ^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/nxtdevices/touchsensor.rst b/doc/main/nxtdevices/touchsensor.rst index 0983afb..e68544b 100644 --- a/doc/main/nxtdevices/touchsensor.rst +++ b/doc/main/nxtdevices/touchsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: nxtdevices NXT Touch Sensor ^^^^^^^^^^^^^^^^ diff --git a/doc/main/nxtdevices/ultrasonicsensor.rst b/doc/main/nxtdevices/ultrasonicsensor.rst index 82c84ce..8139e48 100644 --- a/doc/main/nxtdevices/ultrasonicsensor.rst +++ b/doc/main/nxtdevices/ultrasonicsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: nxtdevices NXT Ultrasonic Sensor ^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/nxtdevices/vernieradapter.rst b/doc/main/nxtdevices/vernieradapter.rst index 99f2c81..e2b9c3d 100644 --- a/doc/main/nxtdevices/vernieradapter.rst +++ b/doc/main/nxtdevices/vernieradapter.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: nxtdevices Vernier Adapter ^^^^^^^^^^^^^^^ diff --git a/doc/main/parameters/font.rst b/doc/main/parameters/font.rst index 2c4a210..f3c7837 100644 --- a/doc/main/parameters/font.rst +++ b/doc/main/parameters/font.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: image Font ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/parameters/image.rst b/doc/main/parameters/image.rst index 1028359..c0a06ef 100644 --- a/doc/main/parameters/image.rst +++ b/doc/main/parameters/image.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: image Image ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/parameters/imagefile.rst b/doc/main/parameters/imagefile.rst index 7218f8a..9e7cc74 100644 --- a/doc/main/parameters/imagefile.rst +++ b/doc/main/parameters/imagefile.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: ev3 +.. pybricks-requirements:: image ImageFile ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/colordistancesensor.rst b/doc/main/pupdevices/colordistancesensor.rst index 081dc80..8d6f369 100644 --- a/doc/main/pupdevices/colordistancesensor.rst +++ b/doc/main/pupdevices/colordistancesensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Color and Distance Sensor ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/colorlightmatrix.rst b/doc/main/pupdevices/colorlightmatrix.rst index 4d629b7..f302ac1 100644 --- a/doc/main/pupdevices/colorlightmatrix.rst +++ b/doc/main/pupdevices/colorlightmatrix.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Color Light Matrix ^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/colorsensor.rst b/doc/main/pupdevices/colorsensor.rst index a3b8c7f..6c0b156 100644 --- a/doc/main/pupdevices/colorsensor.rst +++ b/doc/main/pupdevices/colorsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Color Sensor ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/dcmotor.rst b/doc/main/pupdevices/dcmotor.rst index 20c47ad..c432b35 100644 --- a/doc/main/pupdevices/dcmotor.rst +++ b/doc/main/pupdevices/dcmotor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Motors without rotation sensors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/forcesensor.rst b/doc/main/pupdevices/forcesensor.rst index eacf0e3..cae51d1 100644 --- a/doc/main/pupdevices/forcesensor.rst +++ b/doc/main/pupdevices/forcesensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Force Sensor ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/index.rst b/doc/main/pupdevices/index.rst index 2f8317f..3947558 100644 --- a/doc/main/pupdevices/index.rst +++ b/doc/main/pupdevices/index.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices :mod:`pupdevices ` -- Motors, sensors, lights ================================================================== diff --git a/doc/main/pupdevices/infraredsensor.rst b/doc/main/pupdevices/infraredsensor.rst index a3f1800..c8905cc 100644 --- a/doc/main/pupdevices/infraredsensor.rst +++ b/doc/main/pupdevices/infraredsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Infrared Sensor ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/light.rst b/doc/main/pupdevices/light.rst index 6e56904..43e8aa7 100644 --- a/doc/main/pupdevices/light.rst +++ b/doc/main/pupdevices/light.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Light ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/motor.rst b/doc/main/pupdevices/motor.rst index 22fb230..d2b6256 100644 --- a/doc/main/pupdevices/motor.rst +++ b/doc/main/pupdevices/motor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Motors with rotation sensors ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/pfmotor.rst b/doc/main/pupdevices/pfmotor.rst index e022621..c42561a 100644 --- a/doc/main/pupdevices/pfmotor.rst +++ b/doc/main/pupdevices/pfmotor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Power Functions ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/remote.rst b/doc/main/pupdevices/remote.rst index 76080c7..2e25f88 100644 --- a/doc/main/pupdevices/remote.rst +++ b/doc/main/pupdevices/remote.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Remote Control ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/tiltsensor.rst b/doc/main/pupdevices/tiltsensor.rst index 1aa537f..2219fc5 100644 --- a/doc/main/pupdevices/tiltsensor.rst +++ b/doc/main/pupdevices/tiltsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Tilt Sensor ^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/main/pupdevices/ultrasonicsensor.rst b/doc/main/pupdevices/ultrasonicsensor.rst index 8647970..668c0cf 100644 --- a/doc/main/pupdevices/ultrasonicsensor.rst +++ b/doc/main/pupdevices/ultrasonicsensor.rst @@ -1,4 +1,4 @@ -.. pybricks-requirements:: +.. pybricks-requirements:: pupdevices Ultrasonic Sensor ^^^^^^^^^^^^^^^^^^^^^^^^^