From 6caec24ede0236901af33d98a811d205c35c0cf5 Mon Sep 17 00:00:00 2001 From: Janick Reynders Date: Sat, 24 Feb 2024 00:22:23 +0100 Subject: [PATCH] update docs to new mkdocstrings python handler --- docs/requirements.txt | Bin 592 -> 610 bytes docs/test-all-services.md | 1 + mkdocs.yml | 7 ++++ src/kaspersmicrobit/kaspersmicrobit.py | 3 +- src/kaspersmicrobit/services/accelerometer.py | 16 ++++----- src/kaspersmicrobit/services/buttons.py | 16 ++++----- .../services/device_information.py | 20 +++++------ src/kaspersmicrobit/services/events.py | 24 ++++++------- .../services/generic_access.py | 4 +-- src/kaspersmicrobit/services/io_pin.py | 32 +++++++++--------- src/kaspersmicrobit/services/led.py | 20 +++++------ src/kaspersmicrobit/services/leddisplay.py | 2 +- src/kaspersmicrobit/services/magnetometer.py | 28 +++++++-------- src/kaspersmicrobit/services/temperature.py | 16 ++++----- src/kaspersmicrobit/services/uart.py | 16 ++++----- 15 files changed, 106 insertions(+), 99 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 18ef6feea661c6d206f0354b53f947032005976b..6de51934d03a96a82a7b8f41eab18f1a956a8fb1 100644 GIT binary patch delta 65 zcmcb>@`z=F1|y^4#Qma^Z5WU6+A`QO7&7QFSOBrXWN9W-IbH@Xh9rg@hD3&BhHRj$ PErSt*2~gGuq=Eqe>XQrb delta 48 zcmaFFa)D)o1|y^8#Dl_oVjpq%x#4Br+s3R5I8Cp#g&)gAouLPv&Pb1pq<+ B3d#Tg diff --git a/docs/test-all-services.md b/docs/test-all-services.md index 545d016..5571c73 100644 --- a/docs/test-all-services.md +++ b/docs/test-all-services.md @@ -6,6 +6,7 @@ description: Diagnostic program that prints out which services are enabled on a This example tests which services are available on a micro:bit The API documentation: + - [kaspersmicrobit](reference/kaspersmicrobit.md) Example: diff --git a/mkdocs.yml b/mkdocs.yml index a95fb43..7a8d1b5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -100,6 +100,13 @@ plugins: - sys.modules["bleak"] = mock() options: docstring_style: "google" + members_order: "source" + show_symbol_type_toc: true + docstring_section_style: list + separate_signature: true + line_length: 60 + show_signature_annotations: True + watch: - src/kaspersmicrobit diff --git a/src/kaspersmicrobit/kaspersmicrobit.py b/src/kaspersmicrobit/kaspersmicrobit.py index a9e4916..1c9d5c0 100644 --- a/src/kaspersmicrobit/kaspersmicrobit.py +++ b/src/kaspersmicrobit/kaspersmicrobit.py @@ -155,8 +155,7 @@ def find_microbits(timeout: int = 3, loop: BluetoothEventLoop = None) -> List['K uitvoert. Returns: - List[KaspersMicrobit]: Een lijst van gevonden micro:bits, deze kan ook leeg zijn, - als er geen micro:bits gevonden werden + Een lijst van gevonden micro:bits, deze kan ook leeg zijn, als er geen micro:bits gevonden werden """ diff --git a/src/kaspersmicrobit/services/accelerometer.py b/src/kaspersmicrobit/services/accelerometer.py index d71e406..78436cc 100644 --- a/src/kaspersmicrobit/services/accelerometer.py +++ b/src/kaspersmicrobit/services/accelerometer.py @@ -122,8 +122,8 @@ def notify(self, callback: Callable[[AccelerometerData], None]): zijn van de accelerometer. De nieuwe AccelerometerData worden meegegeven als argument aan deze functie Raises: - BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de + errors.BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de accelerometer data notificaties te activeren (komt normaal gezien niet voor) """ self._device.notify(Service.ACCELEROMETER, Characteristic.ACCELEROMETER_DATA, @@ -137,8 +137,8 @@ def read(self) -> AccelerometerData: De gegevens van de accelerometer (x, y en z) Raises: - BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de + errors.BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de accelerometer data te lezen (komt normaal gezien niet voor) """ return AccelerometerData.from_bytes(self._device.read(Service.ACCELEROMETER, Characteristic.ACCELEROMETER_DATA)) @@ -152,8 +152,8 @@ def set_period(self, period: AccelerometerPeriod): geldige waarden zijn: 1, 2, 5, 10, 20, 80, 160, 640 Raises: - BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de + errors.BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de accelerometer periode te wijzigen (komt normaal gezien niet voor) Warning: @@ -170,8 +170,8 @@ def read_period(self) -> int: Het interval in milliseconden Raises: - BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de + errors.BluetoothServiceNotFound: Wanneer de accelerometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de accelerometer service actief is, maar er geen manier was om de accelerometer periode te lezen (komt normaal gezien niet voor) """ return int.from_bytes(self._device.read(Service.ACCELEROMETER, Characteristic.ACCELEROMETER_PERIOD)[0:2], "little") diff --git a/src/kaspersmicrobit/services/buttons.py b/src/kaspersmicrobit/services/buttons.py index 15eb250..bac7b17 100644 --- a/src/kaspersmicrobit/services/buttons.py +++ b/src/kaspersmicrobit/services/buttons.py @@ -76,8 +76,8 @@ def on_button_a(self, press: ButtonCallback = None, long_press: ButtonCallback = release (ButtonCallback): een functie die wordt opgeroepen wanneer de A knop wordt losgelaten Raises: - BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om de + errors.BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om de notificaties voor button A te activeren (komt normaal gezien niet voor) """ self._device.notify(Service.BUTTON, Characteristic.BUTTON_A, @@ -99,8 +99,8 @@ def on_button_b(self, press: ButtonCallback = None, long_press: ButtonCallback = release (ButtonCallback): een functie die wordt opgeroepen wanneer de B knop wordt losgelaten Raises: - BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om de + errors.BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om de notificaties voor button B te activeren (komt normaal gezien niet voor) """ self._device.notify(Service.BUTTON, Characteristic.BUTTON_B, @@ -114,8 +114,8 @@ def read_button_a(self) -> ButtonState: De toestand van de A knop (RELEASE, PRESS of LONG_PRESS) Raises: - BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om + errors.BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om de staat van button A te lezen (komt normaal gezien niet voor) """ return ButtonState(self._device.read(Service.BUTTON, Characteristic.BUTTON_A)[0]) @@ -128,8 +128,8 @@ def read_button_b(self) -> ButtonState: De toestand van de B knop (RELEASE, PRESS of LONG_PRESS) Raises: - BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om + errors.BluetoothServiceNotFound: Wanneer de button service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de button service actief is, maar er geen manier was om de staat van button B te lezen (komt normaal gezien niet voor) """ return ButtonState(self._device.read(Service.BUTTON, Characteristic.BUTTON_B)[0]) diff --git a/src/kaspersmicrobit/services/device_information.py b/src/kaspersmicrobit/services/device_information.py index eaac280..5957120 100644 --- a/src/kaspersmicrobit/services/device_information.py +++ b/src/kaspersmicrobit/services/device_information.py @@ -28,8 +28,8 @@ def read_model_number(self) -> str: het modelnummer van de micro:bit Raises: - BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was om het modelnummer te lezen (komt normaal gezien niet voor) """ return str(self._device.read(Service.DEVICE_INFORMATION, Characteristic.MODEL_NUMBER_STRING), "utf-8") @@ -42,8 +42,8 @@ def read_serial_number(self) -> str: het serienummer van de micro:bit Raises: - BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was om het serienummer te lezen (komt normaal gezien niet voor) """ return str(self._device.read(Service.DEVICE_INFORMATION, Characteristic.SERIAL_NUMBER_STRING), "utf-8") @@ -56,8 +56,8 @@ def read_firmware_revision(self) -> str: de firmware versie string van de micro:bit Raises: - BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was om de firmware versie te lezen (komt normaal gezien niet voor) """ return str(self._device.read(Service.DEVICE_INFORMATION, Characteristic.FIRMWARE_REVISION_STRING), "utf-8") @@ -74,8 +74,8 @@ def read_hardware_revision(self) -> str: de hardware versie string van de micro:bit Raises: - BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was om de hardware versie te lezen (komt normaal gezien niet voor) """ return str(self._device.read(Service.DEVICE_INFORMATION, Characteristic.HARDWARE_REVISION_STRING), "utf-8") @@ -92,8 +92,8 @@ def read_manufacturer_name(self) -> str: de naam van de fabrikant van de micro:bit Raises: - BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de device information service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de button device information actief is, maar er geen manier was om de naam van de fabrikant te lezen (komt normaal gezien niet voor) """ return str(self._device.read(Service.DEVICE_INFORMATION, Characteristic.MANUFACTURER_NAME_STRING), "utf-8") diff --git a/src/kaspersmicrobit/services/events.py b/src/kaspersmicrobit/services/events.py index 58a6184..2addf93 100644 --- a/src/kaspersmicrobit/services/events.py +++ b/src/kaspersmicrobit/services/events.py @@ -56,8 +56,8 @@ def notify_microbit_requirements(self, callback: Callable[[Event], None]): callback: een functie die wordt opgeroepen met een Event Raises: - BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was om de notificaties voor de microbit requirements te activeren (komt normaal gezien niet voor) """ self._device.notify(Characteristic.MICROBIT_REQUIREMENTS, @@ -75,8 +75,8 @@ def read_microbit_requirements(self) -> List[Event]: List[Event]: Een lijst van events waarvan je de micro:bit moet verwittigen wanneer ze zich voordoen Raises: - BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was om de microbit requirements te lezen (komt normaal gezien niet voor) """ return Event.list_from_bytes(self._device.read(Service.EVENT, Characteristic.MICROBIT_REQUIREMENTS)) @@ -91,8 +91,8 @@ def notify_microbit_event(self, callback: Callable[[Event], None]): callback: een functie die wordt opgeroepen met een Event Raises: - BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was om de notificaties voor de microbit events te activeren (komt normaal gezien niet voor) """ self._device.notify(Service.EVENT, Characteristic.MICROBIT_EVENT, @@ -108,8 +108,8 @@ def read_microbit_event(self) -> List[Event]: List[Event]: Een lijst van events die zich hebben voorgedaan op de micro:bit Raises: - BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was om de microbit events te lezen (komt normaal gezien niet voor) """ return Event.list_from_bytes(self._device.read(Service.EVENT, Characteristic.MICROBIT_EVENT)) @@ -126,8 +126,8 @@ def write_client_requirements(self, *events: Event): *events (Event): de events die je wil ontvangen van de micro:bit Raises: - BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was om de client requirements te schrijven (komt normaal gezien niet voor) """ for event in events: @@ -143,8 +143,8 @@ def write_client_event(self, *events: Event): *events (Event): de events die je wil verzenden naar de micro:bit Raises: - BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de events service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de events service actief is, maar er geen manier was om de client events te schrijven (komt normaal gezien niet voor) """ for event in events: diff --git a/src/kaspersmicrobit/services/generic_access.py b/src/kaspersmicrobit/services/generic_access.py index 270dc78..aaa4d23 100644 --- a/src/kaspersmicrobit/services/generic_access.py +++ b/src/kaspersmicrobit/services/generic_access.py @@ -33,8 +33,8 @@ def read_device_name(self) -> str: de naam van de micro:bit Raises: - BluetoothServiceNotFound: Wanneer de generic access service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de generic acces service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de generic access service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de generic acces service actief is, maar er geen manier was om de device naam te lezen (komt normaal gezien niet voor) """ return str(self._device.read(Service.GENERIC_ACCESS, Characteristic.DEVICE_NAME), "utf-8") diff --git a/src/kaspersmicrobit/services/io_pin.py b/src/kaspersmicrobit/services/io_pin.py index 2c5ed54..7848e43 100644 --- a/src/kaspersmicrobit/services/io_pin.py +++ b/src/kaspersmicrobit/services/io_pin.py @@ -221,8 +221,8 @@ def notify_data(self, callback: Callable[[List[PinValue]], None]): callback: een functie die wordt opgeroepen met een lijst van PinValue objecten Raises: - BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was om de notificaties voor de pin data te activeren (komt normaal gezien niet voor) """ self._device.notify(Service.IO_PIN, Characteristic.PIN_DATA, @@ -236,8 +236,8 @@ def read_data(self) -> List[PinValue]: Een lijst van input pins en hun bijhorende waarde Raises: - BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was om de pin data te lezen (komt normaal gezien niet voor) """ return PinValue.list_from_bytes(self._pin_ad_config, self._device.read(Service.IO_PIN, Characteristic.PIN_DATA)) @@ -251,8 +251,8 @@ def write_data(self, values: List[PinValue]): values (List[PinValue]): de output pins en hun bijhorende waarde Raises: - BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was om de pin data te schrijven (komt normaal gezien niet voor) """ if values: @@ -267,8 +267,8 @@ def read_ad_configuration(self) -> PinADConfiguration: De analoog-digitaal configuratie voor iedere pin Raises: - BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was om de pin analoog-digitaal configuratie te lezen (komt normaal gezien niet voor) """ return PinADConfiguration.from_bytes(self._device.read(Service.IO_PIN, Characteristic.PIN_AD_CONFIGURATION)) @@ -281,8 +281,8 @@ def write_ad_configuration(self, config: PinADConfiguration): config (PinADConfiguration): De analoog-digitaal configuratie voor iedere pin Raises: - BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was om de analoog-digitaal configuratie te schrijven (komt normaal gezien niet voor) """ self._device.write(Service.IO_PIN, Characteristic.PIN_AD_CONFIGURATION, config.to_bytes()) @@ -296,8 +296,8 @@ def read_io_configuration(self) -> PinIOConfiguration: De input-output configuratie voor iedere pin Raises: - BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was om de input-output configuratie te lezen (komt normaal gezien niet voor) """ return PinIOConfiguration.from_bytes(self._device.read(Service.IO_PIN, Characteristic.PIN_IO_CONFIGURATION)) @@ -313,8 +313,8 @@ def write_io_configuration(self, config: PinIOConfiguration): config (PinIOConfiguration): De input-output configuratie voor iedere pin Raises: - BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was om de input-output configuratie te schrijven (komt normaal gezien niet voor) """ self._device.write(Service.IO_PIN, Characteristic.PIN_IO_CONFIGURATION, config.to_bytes()) @@ -332,8 +332,8 @@ def write_pwm_control_data(self, pwm_control1: PwmControlData, pwm_control2: Pwm pwm_control2 (PwmControlData): een optionele PWM opdracht Raises: - BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de I/O pin service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de I/O pin service actief is, maar er geen manier was om de pwm control data te schrijven (komt normaal gezien niet voor) """ data = pwm_control1.to_bytes() + pwm_control2.to_bytes() if pwm_control2 else pwm_control1.to_bytes() diff --git a/src/kaspersmicrobit/services/led.py b/src/kaspersmicrobit/services/led.py index d3c97e2..dbeab50 100644 --- a/src/kaspersmicrobit/services/led.py +++ b/src/kaspersmicrobit/services/led.py @@ -32,8 +32,8 @@ def show(self, led_display: LedDisplay): led_display: de aan/uit staat van de leds Raises: - BluetoothServiceNotFound: Wanneer de led service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de led service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de led service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de led service actief is, maar er geen manier was om de led display te schrijven (komt normaal gezien niet voor) """ self._device.write(Service.LED, Characteristic.LED_MATRIX_STATE, led_display.to_bytes()) @@ -46,8 +46,8 @@ def read(self) -> LedDisplay: de aan/uit staat van de leds Raises: - BluetoothServiceNotFound: Wanneer de led service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de led service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de led service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de led service actief is, maar er geen manier was om de led display te lezen (komt normaal gezien niet voor) """ return LedDisplay.from_bytes(self._device.read(Service.LED, Characteristic.LED_MATRIX_STATE)) @@ -62,8 +62,8 @@ def show_text(self, text: str): Raises: ValueError: indien text meer dan 20 tekens bevat - BluetoothServiceNotFound: Wanneer de led service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de led service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de led service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de led service actief is, maar er geen manier was om de led text te schrijven (komt normaal gezien niet voor) """ octets = text.encode("utf-8") @@ -80,8 +80,8 @@ def set_scrolling_delay(self, delay_in_millis: int): delay_in_millis: de tijd die 1 letter er over doet om over het scherm voorbij te komen in milliseconden Raises: - BluetoothServiceNotFound: Wanneer de led service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de led service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de led service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de led service actief is, maar er geen manier was om de scrolling delay te schrijven (komt normaal gezien niet voor) """ self._device.write(Service.LED, Characteristic.SCROLLING_DELAY, delay_in_millis.to_bytes(2, 'little')) @@ -94,8 +94,8 @@ def get_scrolling_delay(self) -> int: de tijd die 1 letter er over doet om over het scherm voorbij te komen in milliseconden Raises: - BluetoothServiceNotFound: Wanneer de led service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de led service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de led service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de led service actief is, maar er geen manier was om de scrolling delay te lezen (komt normaal gezien niet voor) """ return int.from_bytes(self._device.read(Service.LED, Characteristic.SCROLLING_DELAY)[0:2], 'little') diff --git a/src/kaspersmicrobit/services/leddisplay.py b/src/kaspersmicrobit/services/leddisplay.py index c2da05d..782d6de 100644 --- a/src/kaspersmicrobit/services/leddisplay.py +++ b/src/kaspersmicrobit/services/leddisplay.py @@ -54,7 +54,7 @@ def from_bytes(value: ByteData): return LedDisplay(bytearray(value)) @staticmethod - def image(string: str, on='#', off='.') -> 'LedDisplay': + def image(string: str, on: str = '#', off: str = '.') -> 'LedDisplay': """ Maakt een LedDisplay van een string. diff --git a/src/kaspersmicrobit/services/magnetometer.py b/src/kaspersmicrobit/services/magnetometer.py index 10e3517..e838203 100644 --- a/src/kaspersmicrobit/services/magnetometer.py +++ b/src/kaspersmicrobit/services/magnetometer.py @@ -122,8 +122,8 @@ def notify_data(self, callback: Callable[[MagnetometerData], None]): zijn van de magnetometer. De nieuwe MagnetometerData worden meegegeven als argument aan deze functie Raises: - BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was om de notificaties van magnetometer data te activeren (komt normaal gezien niet voor) """ self._device.notify(Service.MAGNETOMETER, Characteristic.MAGNETOMETER_DATA, @@ -137,8 +137,8 @@ def read_data(self) -> MagnetometerData: De gegevens van de magnetometer (x, y en z) Raises: - BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was om de magnetometer data te lezen (komt normaal gezien niet voor) """ return MagnetometerData.from_bytes(self._device.read(Service.MAGNETOMETER, Characteristic.MAGNETOMETER_DATA)) @@ -156,8 +156,8 @@ def set_period(self, period: MagnetometerPeriod): TODO te onderzoeken Raises: - BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was om de magnetometer periode te schrijven (komt normaal gezien niet voor) """ self._device.write(Service.MAGNETOMETER, Characteristic.MAGNETOMETER_PERIOD, period.to_bytes(2, "little")) @@ -170,8 +170,8 @@ def read_period(self) -> int: Het interval in milliseconden Raises: - BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was om de magnetometer periode te lezen (komt normaal gezien niet voor) """ return int.from_bytes( @@ -190,8 +190,8 @@ def notify_bearing(self, callback: Callable[[int], None]): opzichte van het noorden Raises: - BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was om de notificaties van magnetometer bearing te activeren (komt normaal gezien niet voor) """ self._device.notify(Service.MAGNETOMETER, Characteristic.MAGNETOMETER_BEARING, @@ -205,8 +205,8 @@ def read_bearing(self) -> int: de hoek in graden tov het noorden Raises: - BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was om de magnetometer bearing te lezen (komt normaal gezien niet voor) """ return int.from_bytes( @@ -228,8 +228,8 @@ def calibrate(self) -> Calibration: De calibratie gedaan is. Raises: - BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de magnetometer service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de magnetometer service actief is, maar er geen manier was om de magnetometer calibratie te activeren of op te volgen (komt normaal gezien niet voor) """ if self._calibration and not self._calibration.done(): diff --git a/src/kaspersmicrobit/services/temperature.py b/src/kaspersmicrobit/services/temperature.py index c3d37a1..d76622a 100644 --- a/src/kaspersmicrobit/services/temperature.py +++ b/src/kaspersmicrobit/services/temperature.py @@ -39,8 +39,8 @@ def notify(self, callback: Callable[[int], None]): callback: een functie die periodiek wordt opgeroepen met de temperatuur als argument Raises: - BluetoothServiceNotFound: Wanneer de temperatuur service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de temperatuur service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de temperatuur service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de temperatuur service actief is, maar er geen manier was om de notificaties van temperatuur data te activeren (komt normaal gezien niet voor) """ self._device.notify(Service.TEMPERATURE, Characteristic.TEMPERATURE, @@ -54,8 +54,8 @@ def read(self) -> int: de temperatuur in graden Celcius Raises: - BluetoothServiceNotFound: Wanneer de temperatuur service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de temperatuur service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de temperatuur service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de temperatuur service actief is, maar er geen manier was om de temperatuur te lezen (komt normaal gezien niet voor) """ return int.from_bytes( @@ -70,8 +70,8 @@ def set_period(self, period: int): period (int): het interval waarmee je temperatuurgegevens ontvangt in milliseconden Raises: - BluetoothServiceNotFound: Wanneer de temperatuur service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de temperatuur service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de temperatuur service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de temperatuur service actief is, maar er geen manier was om de temperatuur periode te schrijven (komt normaal gezien niet voor) """ self._device.write(Service.TEMPERATURE, Characteristic.TEMPERATURE_PERIOD, period.to_bytes(2, "little")) @@ -84,8 +84,8 @@ def read_period(self) -> int: Het interval in milliseconden Raises: - BluetoothServiceNotFound: Wanneer de temperatuur service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de temperatuur service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de temperatuur service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de temperatuur service actief is, maar er geen manier was om de temperatuur periode te lezen (komt normaal gezien niet voor) """ return int.from_bytes( diff --git a/src/kaspersmicrobit/services/uart.py b/src/kaspersmicrobit/services/uart.py index 8265817..93c9c8e 100644 --- a/src/kaspersmicrobit/services/uart.py +++ b/src/kaspersmicrobit/services/uart.py @@ -37,8 +37,8 @@ def receive(self, callback: Callable[[ByteData], None]): callback (Callable[[ByteData], None]): een functie wordt opgeroepen met de ontvangen bytes Raises: - BluetoothServiceNotFound: Wanneer de uart service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de uart service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de uart service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de uart service actief is, maar er geen manier was om de notificaties van uart data te activeren (komt normaal gezien niet voor) """ self._device.notify(Service.UART, Characteristic.TX_CHARACTERISTIC, lambda sender, data: callback(data)) @@ -52,8 +52,8 @@ def receive_string(self, callback: Callable[[str], None]): callback (Callable[[str], None]): een functie wordt opgeroepen met de ontvangen string Raises: - BluetoothServiceNotFound: Wanneer de uart service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de uart service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de uart service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de uart service actief is, maar er geen manier was om de notificaties van uart data te activeren (komt normaal gezien niet voor) """ self.receive(UartService.to_string(callback)) @@ -66,8 +66,8 @@ def send(self, data: ByteData): data (ByteData): de bytes die verzonden worden Raises: - BluetoothServiceNotFound: Wanneer de uart service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de uart service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de uart service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de uart service actief is, maar er geen manier was om data via de uart service te verzenden (komt normaal gezien niet voor) """ for i in range(0, len(data), PDU_BYTE_LIMIT): @@ -81,8 +81,8 @@ def send_string(self, string: str): string (str): de string die verzonden wordt Raises: - BluetoothServiceNotFound: Wanneer de uart service niet actief is op de micro:bit - BluetoothCharacteristicNotFound: Wanneer de uart service actief is, maar er geen manier was + errors.BluetoothServiceNotFound: Wanneer de uart service niet actief is op de micro:bit + errors.BluetoothCharacteristicNotFound: Wanneer de uart service actief is, maar er geen manier was om data via de uart service te verzenden (komt normaal gezien niet voor) """ self.send(UartService.from_string(string))