Helix

Helix(file_path=None)

Main entry point for interacting with Helix files and devices.

This class provides methods for loading Helix bundle files and managing setlists.

Initialize the Helix class.

Parameters:

Name	Type	Description	Default
file_path	str	Path to the bundle file to load. Defaults to None.	None

Examples:

helix = Helix()

Returns:

Type	Description
None	None

Source code in helixapi\helix.py

def __init__(self, file_path=None) -> None:
    """
    Initialize the Helix class.

    Args:
        file_path (str, optional): Path to the bundle file to load. Defaults to None.

    Examples:
    ``` py
    helix = Helix()
    ```

    Returns:
        None
    """
    # Load settings
    self._settings = Settings()

    # Setup logging
    self._setup_logging(log_level=self._settings.log_level)

    self.midi = MIDI()

    # Initialize _setlists to None
    self._setlists = None

    # Load the bundle (which also loads the setlist, presets, snapshots, etc)
    self._bundle = Bundle(file_path=file_path, setlists_callback=self._reload_setlists)

bundle property

Get the loaded bundle.

Returns:

Name	Type	Description
Bundle		The loaded bundle.

Examples:

helix.bundle

midi = MIDI() instance-attribute

setlists: Setlists property writable

Get the setlists for the current bundle.

Returns:

Name	Type	Description
Setlists	Setlists	The setlists for the current bundle.

Examples:

helix.setlists