spikeble 0.1__py3-none-any.whl

app/__init__.py

@@ -0,0 +1,3 @@
+"The app module is used communicate between hub and app"
+
+raise NotImplementedError(f"The {__package__} module is not implemented on Spike")

app/bargraph.py

@@ -0,0 +1,24 @@
+"The bargraph module is used make bar graphs in the SPIKE App"
+
+from typing import Awaitable
+
+
+def change(color: int, value: float) -> None:
+    assert 0 <= color <= 10, "Color must be between 0 and 10"
+    assert 0 <= value <= 100, "Value must be between 0 and 100"
+
+
+def clear_all() -> None:
+    pass
+
+
+async def get_value(color: int) -> Awaitable:
+    pass
+
+
+def set_value(color: int, value: float) -> None:
+    pass
+
+
+def show(fullscreen: bool) -> None:
+    pass

app/display.py

@@ -0,0 +1,39 @@
+"The display module is used show images in the SPIKE App"
+
+IMAGE_ROBOT_1 = 1
+IMAGE_ROBOT_2 = 2
+IMAGE_ROBOT_3 = 3
+IMAGE_ROBOT_4 = 4
+IMAGE_ROBOT_5 = 5
+IMAGE_HUB_1 = 6
+IMAGE_HUB_2 = 7
+IMAGE_HUB_3 = 8
+IMAGE_HUB_4 = 9
+IMAGE_AMUSEMENT_PARK = 10
+IMAGE_BEACH = 11
+IMAGE_HAUNTED_HOUSE = 12
+IMAGE_CARNIVAL = 13
+IMAGE_BOOKSHELF = 14
+IMAGE_PLAYGROUND = 15
+IMAGE_MOON = 16
+IMAGE_CAVE = 17
+IMAGE_OCEAN = 18
+IMAGE_POLAR_BEAR = 19
+IMAGE_PARK = 20
+IMAGE_RANDOM = 21
+
+
+def hide() -> None:
+    pass
+
+
+def image(image: int) -> None:
+    assert 1 <= image <= 21, "Image must be between 1 and 21"
+
+
+def show(fullscreen: bool) -> None:
+    pass
+
+
+def text(text: str) -> None:
+    pass

app/linegraph.py

@@ -0,0 +1,39 @@
+"The linegraph module is used make line graphs in the SPIKE App"
+
+from typing import Awaitable
+
+
+def clear(color: int) -> None:
+    assert 0 <= color <= 10, "Color must be between 0 and 10"
+
+
+def clear_all() -> None:
+    pass
+
+
+async def get_average(color: int) -> Awaitable:
+    assert 0 <= color <= 10, "Color must be between 0 and 10"
+
+
+async def get_last(color: int) -> Awaitable:
+    assert 0 <= color <= 10, "Color must be between 0 and 10"
+
+
+async def get_max(color: int) -> Awaitable:
+    assert 0 <= color <= 10, "Color must be between 0 and 10"
+
+
+async def get_min(color: int) -> Awaitable:
+    assert 0 <= color <= 10, "Color must be between 0 and 10"
+
+
+def hide() -> None:
+    pass
+
+
+def plot(color: int, x: float, y: float) -> None:
+    assert 0 <= color <= 10, "Color must be between 0 and 10"
+
+
+def show(fullscreen: bool) -> None:
+    pass

app/music.py

@@ -0,0 +1,51 @@
+# Drum constants
+DRUM_SNARE = 1
+DRUM_BASS = 2
+DRUM_SIDE_STICK = 3
+DRUM_CRASH_CYMBAL = 4
+DRUM_OPEN_HI_HAT = 5
+DRUM_CLOSED_HI_HAT = 6
+DRUM_TAMBOURINE = 7
+DRUM_HAND_CLAP = 8
+DRUM_CLAVES = 9
+DRUM_WOOD_BLOCK = 10
+DRUM_COWBELL = 11
+DRUM_TRIANGLE = 12
+DRUM_BONGO = 13
+DRUM_CONGA = 14
+DRUM_CABASA = 15
+DRUM_GUIRO = 16
+DRUM_VIBRASLAP = 17
+DRUM_CUICA = 18
+
+# Instrument constants
+INSTRUMENT_PIANO = 1
+INSTRUMENT_ELECTRIC_PIANO = 2
+INSTRUMENT_ORGAN = 3
+INSTRUMENT_GUITAR = 4
+INSTRUMENT_ELECTRIC_GUITAR = 5
+INSTRUMENT_BASS = 6
+INSTRUMENT_PIZZICATO = 7
+INSTRUMENT_CELLO = 8
+INSTRUMENT_TROMBONE = 9
+INSTRUMENT_CLARINET = 10
+INSTRUMENT_SAXOPHONE = 11
+INSTRUMENT_FLUTE = 12
+INSTRUMENT_WOODEN_FLUTE = 13
+INSTRUMENT_BASSOON = 14
+INSTRUMENT_CHOIR = 15
+INSTRUMENT_VIBRAPHONE = 16
+INSTRUMENT_MUSIC_BOX = 17
+INSTRUMENT_STEEL_DRUM = 18
+INSTRUMENT_MARIMBA = 19
+INSTRUMENT_SYNTH_LEAD = 20
+INSTRUMENT_SYNTH_PAD = 21
+
+
+def play_drum(drum: int) -> None:
+    assert 1 <= drum <= 18, "Drum must be between 1 and 18"
+
+
+def play_instrument(instrument: int, note: int, duration: int) -> None:
+    assert 1 <= instrument <= 21, "Instrument must be between 1 and 21"
+    assert 1 <= note <= 130, "Note must be between 1 and 130"

app/sound.py

@@ -0,0 +1,18 @@
+from typing import Awaitable
+
+
+async def play(
+    sound_name: str, volume: int = 100, pitch: int = 0, pan: int = 0
+) -> Awaitable:
+    """Play a sound in the SPIKE App"""
+    assert 0 <= volume <= 100, "Volume must be between 0 and 100"
+    assert -100 <= pan <= 100, "Pan must be between -100 and 100"
+
+
+def set_attributes(volume: int, pitch: int, pan: int) -> None:
+    assert 0 <= volume <= 100, "Volume must be between 0 and 100"
+    assert -100 <= pan <= 100, "Pan must be between -100 and 100"
+
+
+def stop() -> None:
+    pass

color/__init__.py

@@ -0,0 +1,14 @@
+"The color module contains all the color constants to use with the color_matrix, color_sensor and light modules."
+
+BLACK = 0
+MAGENTA = 1
+PURPLE = 2
+BLUE = 3
+AZURE = 4
+TURQUOISE = 5
+GREEN = 6
+YELLOW = 7
+ORANGE = 8
+RED = 9
+WHITE = 10
+UNKNOWN = -1

color_matrix/__init__.py

@@ -0,0 +1,18 @@
+def clear(port: int) -> None:
+    "Turn off all pixels on a Color Matrix"
+    assert port in range(6), "Invalid port"
+
+
+def get_pixel(port: int, x: int, y: int) -> tuple[int, int]:
+    "Retrieve a specific pixel represented as a tuple containing the color and intensity"
+    assert port in range(6), "Invalid port"
+
+
+def set_pixel(port: int, x: int, y: int, pixel: tuple[int, int]) -> None:
+    "Change a single pixel on a Color Matrix"
+    assert port in range(6), "Invalid port"
+
+
+def show(port: int, pixels: list[tuple[int, int]]) -> None:
+    "Change all pixels at once on a Color Matrix"
+    assert port in range(6), "Invalid port"

color_sensor/__init__.py

@@ -0,0 +1,16 @@
+"The `color_sensor` module enables you to write code that reacts to specific colors or the intensity of the reflected light."
+
+
+async def color(port: int) -> int:
+    "Returns the color value of the detected color. Use the `color` module to map the color value to a specific color."
+    assert port in range(6), "Invalid port"
+
+
+async def reflection(port: int) -> int:
+    "Retrieves the intensity of the reflected light (0-100%)."
+    assert port in range(6), "Invalid port"
+
+
+async def rgbi(port: int) -> tuple[int, int, int, int]:
+    "Retrieves the overall color intensity and intensity of red, green and blue."
+    assert port in range(6), "Invalid port"

device/__init__.py

@@ -0,0 +1,27 @@
+"The `device` module enables you to write code to get information about devices plugged into the hub."
+
+
+async def data(port: int) -> tuple[int]:
+    "Retrieve the raw LPF-2 data from a device."
+    assert port in range(6), "Invalid port"
+
+
+async def id(port: int) -> int:
+    "Retrieve the device id of a device. Each device has an id based on its type."
+    assert port in range(6), "Invalid port"
+
+
+async def get_duty_cycle(port: int) -> int:
+    "Retrieve the duty cycle for a device. Returned values is in range 0 to 10000"
+    assert port in range(6), "Invalid port"
+
+
+async def ready(port: int) -> bool:
+    "When a device is attached to the hub it might take a short amount of time before it's ready to accept requests. Use `ready` to test for the readiness of the attached devices."
+    assert port in range(6), "Invalid port"
+
+
+async def set_duty_cycle(port: int, duty_cycle: int) -> None:
+    "Set the duty cycle for a device. Accepted values are in range 0 to 10000."
+    assert port in range(6), "Invalid port"
+    assert duty_cycle in range(10001), "Invalid duty cycle"

distance_sensor/__init__.py

@@ -0,0 +1,30 @@
+"""The distance_sensor module enables you to write code that reacts to specific distances or light up the Distance Sensor in different ways."""
+
+
+async def clear(port: int) -> None:
+    "Turns off all the lights in the Distance Sensor connected to `port`."
+    assert port in range(6), "Invalid port"
+
+
+async def distance(port: int) -> int:
+    "Retrieve the distance in millimeters captured by the Distance Sensor connected to `port`. If the Distance Sensor cannot read a valid distance it will return -1."
+    assert port in range(6), "Invalid port"
+
+
+async def get_pixel(port: int, x: int, y: int) -> int:
+    "Retrieve the intensity of a specific light on the Distance Sensor connected to `port`."
+    assert port in range(6), "Invalid port"
+    assert x in range(4), "Invalid x coordinate"
+    assert y in range(4), "Invalid y coordinate"
+
+
+async def set_pixel(port: int, x: int, y: int, intensity: int) -> None:
+    "Changes the intensity of a specific light on the Distance Sensor connected to `port`."
+    assert port in range(6), "Invalid port"
+    assert x in range(4), "Invalid x coordinate"
+    assert y in range(4), "Invalid y coordinate"
+
+
+async def show(port: int, pixels: list[int]) -> None:
+    "Change all the lights at the same time."
+    assert port in range(6), "Invalid port"

force_sensor/__init__.py

@@ -0,0 +1,65 @@
+"""
+The `force_sensor` module contains all functions and constants to use the Force Sensor.
+
+To use the Force Sensor module add the following import statement to your project:
+
+>>> import force_sensor
+
+All functions in the module should be called inside the force_sensor module as a prefix like so:
+
+>>> force_sensor.force(port.A)
+"""
+
+
+async def force(port: int) -> int:
+    """
+    Retrieves the measured force in decinewtons (0 to 100).
+
+    Example
+    -------
+    >>> from hub import port
+    >>> import force_sensor
+    >>> print(force_sensor.force(port.A))
+
+    Parameters
+    ----------
+    port : int
+        A port from the `port` submodule in the hub module.
+    """
+    assert port in range(6), "Invalid port"
+
+
+async def pressed(port: int) -> bool:
+    """
+    Tests whether the button on the sensor is pressed. Returns true if the force sensor connected to port is pressed.
+
+    Example
+    -------
+    >>> from hub import port
+    >>> import force_sensor
+    >>> print(force_sensor.pressed(port.A))
+
+    Parameters
+    ----------
+    port : int
+        A port from the `port` submodule in the hub module.
+    """
+    assert port in range(6), "Invalid port"
+
+
+async def raw(port: int) -> int:
+    """
+    Returns the raw, uncalibrated force value of the force sensor connected on `port`.
+
+    Example
+    -------
+    >>> from hub import port
+    >>> import force_sensor
+    >>> print(force_sensor.raw(port.A))
+
+    Parameters
+    ----------
+    port : int
+        A port from the `port` submodule in the hub module.
+    """
+    assert port in range(6), "Invalid port"

hub/__init__.py

@@ -0,0 +1,13 @@
+def hardware_id() -> str:
+    """Retrieve the hardware id."""
+    pass
+
+
+def power_off() -> int:
+    """Turns off the hub."""
+    pass
+
+
+def temperature() -> int:
+    """Retrieve the hub temperature. Measured in decidegrees celsius (d°C) which is 1 / 10 of a degree celsius (°C)"""
+    pass

hub/button.py

@@ -0,0 +1,37 @@
+"""
+This module allows you to react to buttons being pressed on the hub. You must first import the `button` module to use the buttons.
+
+To use the Button module add the following import statement to your project:
+
+
+>>> from hub import button
+
+All functions in the module should be called inside the `button` module as a prefix like so:
+
+>>> button.pressed(button.LEFT)
+
+"""
+
+LEFT = 1
+"""Left button next to the power button on the SPIKE Prime hub"""
+RIGHT = 2
+"""Right button next to the power button on the SPIKE Prime hub"""
+
+
+def pressed(button: int) -> int:
+    """
+    ```python
+    from hub import button
+    left_button_press_duration = 0
+
+    # Wait for the left button to be pressed
+    while not button.pressed(button.LEFT):
+        pass
+
+    # As long as the left button is being pressed, update the `left_button_press_duration` variable
+    while button.pressed(button.LEFT):
+        left_button_press_duration = button.pressed(button.LEFT)
+
+    print("Left button was pressed for " + str(left_button_press_duration) + " milliseconds")
+    ```
+    """

hub/light.py

@@ -0,0 +1,38 @@
+"""
+The light module includes functions to change the color of the light on the SPIKE Prime hub.
+
+To use the Light module add the following import statement to your project:
+
+>>> from hub import light
+
+All functions in the module should be called inside the light module as a prefix like so:
+
+>>> light.color(color.RED)
+"""
+
+POWER = 0
+"""The power button. On SPIKE Prime it's the button between the left and right buttons."""
+CONNECT = 1
+"""The light around the Bluetooth connect button on SPIKE Prime."""
+
+
+def color(light: int, color: int) -> None:
+    """
+    Change the color of a light on the hub.
+    ```python
+    from hub import light
+    import color
+
+    # Change the light to red
+    light.color(light.POWER, color.RED)
+    ```
+
+    Parameters
+    ----------
+
+    light : int
+        The light on the hub
+    color : int
+        A color from the `color` module
+    """
+    assert 0 <= color <= 10, "Color must be between 0 and 10"

hub/light_matrix.py

@@ -0,0 +1,249 @@
+"""
+To use the Light Matrix module add the following import statement to your project:
+
+>>> from hub import light_matrix
+
+All functions in the module should be called inside the light_matrix module as a prefix like so:
+
+>>> light_matrix.write("Hello World")
+"""
+
+from typing import Awaitable
+
+IMAGE_HEART = 1
+IMAGE_HEART_SMALL = 2
+IMAGE_HAPPY = 3
+IMAGE_SMILE = 4
+IMAGE_SAD = 5
+IMAGE_CONFUSED = 6
+IMAGE_ANGRY = 7
+IMAGE_ASLEEP = 8
+IMAGE_SURPRISED = 9
+IMAGE_SILLY = 10
+IMAGE_FABULOUS = 11
+IMAGE_MEH = 12
+IMAGE_YES = 13
+IMAGE_NO = 14
+IMAGE_CLOCK12 = 15
+IMAGE_CLOCK1 = 16
+IMAGE_CLOCK2 = 17
+IMAGE_CLOCK3 = 18
+IMAGE_CLOCK4 = 19
+IMAGE_CLOCK5 = 20
+IMAGE_CLOCK6 = 21
+IMAGE_CLOCK7 = 22
+IMAGE_CLOCK8 = 23
+IMAGE_CLOCK9 = 24
+IMAGE_CLOCK10 = 25
+IMAGE_CLOCK11 = 26
+IMAGE_ARROW_N = 27
+IMAGE_ARROW_NE = 28
+IMAGE_ARROW_E = 29
+IMAGE_ARROW_SE = 30
+IMAGE_ARROW_S = 31
+IMAGE_ARROW_SW = 32
+IMAGE_ARROW_W = 33
+IMAGE_ARROW_NW = 34
+IMAGE_GO_RIGHT = 35
+IMAGE_GO_LEFT = 36
+IMAGE_GO_UP = 37
+IMAGE_GO_DOWN = 38
+IMAGE_TRIANGLE = 39
+IMAGE_TRIANGLE_LEFT = 40
+IMAGE_CHESSBOARD = 41
+IMAGE_DIAMOND = 42
+IMAGE_DIAMOND_SMALL = 43
+IMAGE_SQUARE = 44
+IMAGE_SQUARE_SMALL = 45
+IMAGE_RABBIT = 46
+IMAGE_COW = 47
+IMAGE_MUSIC_CROTCHET = 48
+IMAGE_MUSIC_QUAVER = 49
+IMAGE_MUSIC_QUAVERS = 50
+IMAGE_PITCHFORK = 51
+IMAGE_XMAS = 52
+IMAGE_PACMAN = 53
+IMAGE_TARGET = 54
+IMAGE_TSHIRT = 55
+IMAGE_ROLLERSKATE = 56
+IMAGE_DUCK = 57
+IMAGE_HOUSE = 58
+IMAGE_TORTOISE = 59
+IMAGE_BUTTERFLY = 60
+IMAGE_STICKFIGURE = 61
+IMAGE_GHOST = 62
+IMAGE_SWORD = 63
+IMAGE_GIRAFFE = 64
+IMAGE_SKULL = 65
+IMAGE_UMBRELLA = 66
+IMAGE_SNAKE = 67
+
+
+def clear() -> None:
+    """
+    Switches off all of the pixels on the Light Matrix.
+
+    Example
+    -------
+    ```python
+
+    from hub import light_matrix
+    import time
+    # Update pixels to show an image on Light Matrix, and then turn them off using the clear function
+
+    # Show a small heart
+    light_matrix.show_image(2)
+
+    # Wait for two seconds
+    time.sleep_ms(2000)
+
+    # Switch off the heart
+    light_matrix.clear()
+    ```
+    """
+    pass
+
+
+def get_orientation() -> int:
+    """
+    Retrieve the current orientation of the Light Matrix.
+    Can be used with the following constants: `orientation.UP`, `orientation.LEFT`, `orientation.RIGHT`, `orientation.DOWN`
+    """
+    pass
+
+
+def get_pixel(x: int, y: int) -> int:
+    """
+    Retrieve the intensity of a specific pixel on the Light Matrix.
+
+    Example
+    -------
+    ```python
+
+    from hub import light_matrix
+
+    # Show a heart
+    light_matrix.show_image(1)
+
+    # Print the value of the center pixel's intensity
+    print(light_matrix.get_pixel(2, 2))
+    ```
+
+    Parameters
+    ----------
+
+    x : int
+        The X value, range (0 - 4)
+    y : int
+        The Y value, range (0 - 4)
+    """
+    pass
+
+
+def set_orientation(top: int) -> int:
+    """
+        Change the orientation of the Light Matrix. All subsequent calls will use the new orientation.
+    Can be used with the following constants: `orientation.UP`, `orientation.LEFT`, `orientation.RIGHT`, `orientation.DOWN`
+
+        Parameters
+        ----------
+        top : int
+            The side of the hub to be the top
+    """
+    pass
+
+
+def set_pixel(x: int, y: int, intensity: int) -> None:
+    """
+    Sets the brightness of one pixel (one of the 25 LEDs) on the Light Matrix.
+
+    Example
+    -------
+    ```python
+    from hub import light_matrix
+    # Turn on the pixel in the center of the hub
+    light_matrix.set_pixel(2, 2, 100)
+    ```
+
+    Parameters
+    ----------
+    x : int
+        The X value, range (0 - 4)
+    y : int
+        The Y value, range (0 - 4)
+    intensity : int
+        How bright to light up the pixel
+    """
+    pass
+
+
+def show(pixels: list[int]) -> None:
+    """
+    Change all the lights at the same time.
+
+    Example
+    -------
+    ```python
+    from hub import light_matrix
+    # Update all pixels on Light Matrix using the show function
+
+    # Create a list with 25 identical intensity values
+    pixels = [100] * 25
+
+    # Update all pixels to show same intensity
+    light_matrix.show(pixels)
+    ```
+
+    Parameters
+    ----------
+    pixels : list[int]
+        A list containing light intensity values for all 25 pixels.
+    """
+    pass
+
+
+def show_image(image: int) -> None:
+    """
+    Display one of the built in images on the display.
+
+    Example
+    -------
+    ```python
+    from hub import light_matrix
+    # Update pixels to show an image on Light Matrix using the show_image function
+
+    # Show a smiling face
+    light_matrix.show_image(light_matrix.IMAGE_HAPPY)
+    ```
+
+    Parameters
+    ----------
+    image : int
+        The id of the image to show. The range of available images is 1 to 67. There are consts on the `light_matrix` module for these.
+    """
+    pass
+
+
+async def write(
+    text: str, intensity: int = 100, time_per_character: int = 500
+) -> Awaitable:
+    """
+    Displays text on the Light Matrix, one letter at a time, scrolling from right to left except if there is a single character to show which will not scroll
+
+    Example
+    -------
+    ```python
+    from hub import light_matrix
+    # Write a message to the hub
+    light_matrix.write("Hello, world!")
+    ```
+
+    Parameters
+    ----------
+    text : str
+        The text to display
+    intensity : int
+        How bright to light up the pixel
+    time_per_character : int
+        How long to show each character on the display
+    """