pycycling

https://zacharyedwardbull.github.io/pycycling/
Admin
A cross-platform Python package for interacting with various Bluetooth cycling peripherals including...
Tokens:2,154
Snippets:14
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### CyclingSpeedCadenceService Methods

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Methods for enabling notifications, getting features, and setting handlers for Cycling Speed and Cadence Service.

```APIDOC
## CyclingSpeedCadenceService

### Description
Provides methods to interact with the Cycling Speed and Cadence Service.

### Methods
- `enable_csc_measurement_notifications()`: Enables notifications for CSC measurements.
- `get_csc_feature()`: Retrieves the CSC feature information.
- `set_csc_measurement_handler(handler)`: Sets a handler for CSC measurement data.
```

--------------------------------

### FitnessMachineService Methods

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Methods for controlling and retrieving information from a Fitness Machine.

```APIDOC
## FitnessMachineService

### Description
Provides comprehensive control and data retrieval for Fitness Machines.

### Methods
- `disable_control_point_indicate()`: Disables control point indication.
- `disable_fitness_machine_status_notify()`: Disables fitness machine status notifications.
- `disable_indoor_bike_data_notify()`: Disables indoor bike data notifications.
- `disable_training_status_notify()`: Disables training status notifications.
- `enable_control_point_indicate()`: Enables control point indication.
- `enable_fitness_machine_status_notify()`: Enables fitness machine status notifications.
- `enable_indoor_bike_data_notify()`: Enables indoor bike data notifications.
- `enable_training_status_notify()`: Enables training status notifications.
- `get_all_features()`: Retrieves all supported features of the fitness machine.
- `get_fitness_machine_feature()`: Retrieves a specific fitness machine feature.
- `get_supported_power_range()`: Gets the supported power range.
- `get_supported_resistance_level_range()`: Gets the supported resistance level range.
- `get_target_setting_feature()`: Retrieves the target setting feature.
- `request_control()`: Requests control of the fitness machine.
- `reset()`: Resets the fitness machine.
- `set_control_point_response_handler(handler)`: Sets a handler for control point responses.
- `set_fitness_machine_status_handler(handler)`: Sets a handler for fitness machine status updates.
- `set_indoor_bike_data_handler(handler)`: Sets a handler for indoor bike data.
- `set_simulation_parameters(parameters)`: Sets simulation parameters for the trainer.
- `set_spin_down_control()`: Sets the spin-down control.
- `set_target_heart_rate(target_hr)`: Sets the target heart rate.
- `set_target_incline(target_incline)`: Sets the target incline.
- `set_target_power(target_power)`: Sets the target power output.
- `set_target_resistance_level(target_level)`: Sets the target resistance level.
- `set_target_speed(target_speed)`: Sets the target speed.
- `set_targeted_cadence(target_cadence)`: Sets the target cadence.
- `set_targeted_distance(target_distance)`: Sets the target distance.
- `set_targeted_expended_energy(target_energy)`: Sets the target expended energy.
- `set_targeted_number_of_steps(target_steps)`: Sets the target number of steps.
- `set_targeted_number_of_strides(target_strides)`: Sets the target number of strides.
- `set_targeted_time_in_five_heart_rate_zones(target_time)`: Sets the target time in five heart rate zones.
- `set_targeted_time_in_three_heart_rate_zones(target_time)`: Sets the target time in three heart rate zones.
- `set_targeted_time_in_two_heart_rate_zones(target_time)`: Sets the target time in two heart rate zones.
- `set_targeted_training_time(target_time)`: Sets the target training time.
- `set_training_status_handler(handler)`: Sets a handler for training status updates.
- `set_wheel_circumference(circumference)`: Sets the wheel circumference.
- `start_or_resume()`: Starts or resumes the workout.
- `stop_or_pause()`: Stops or pauses the workout.
```

--------------------------------

### Discover Bluetooth Devices

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Use this script to discover and print available Bluetooth devices. Obtain the device address from the output for use in other scripts.

```python
"""
An example script which lists all available bluetooth devices. Use this to obtain the device_address used in other
scripts
"""

import asyncio
from bleak import discover


async def run():
    devices = await discover()
    for d in devices:
        print(d)


if __name__ == "__main__":
    import os

    os.environ["PYTHONASYNCIODEBUG"] = str(1)

    loop = asyncio.get_event_loop()
    loop.run_until_complete(run())

```

--------------------------------

### Sterzo Methods

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Methods for enabling steering measurement notifications and setting callbacks.

```APIDOC
## Sterzo

### Description
Manages steering measurement notifications and callbacks for Sterzo devices.

### Methods
- `disable_steering_measurement_notifications()`: Disables steering measurement notifications.
- `enable_steering_measurement_notifications()`: Enables steering measurement notifications.
- `set_steering_measurement_callback(callback)`: Sets a callback function for steering measurements.
```

--------------------------------

### TacxTrainerControl Methods

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Provides methods for controlling Tacx trainers, including enabling/disabling notifications, requesting data, and setting various resistance and configuration parameters.

```APIDOC
## TacxTrainerControl

### Description
This class provides methods to interact with and control Tacx trainers.

### Methods

- **disable_fec_notifications()**
  Disables FEC notifications.

- **enable_fec_notifications()**
  Enables FEC notifications.

- **request_data_page()**
  Requests a data page from the trainer.

- **set_basic_resistance(resistance: int)**
  Sets the basic resistance level.

- **set_command_status_data_page_handler(handler: callable)**
  Sets a handler for command status data pages.

- **set_general_fe_data_page_handler(handler: callable)**
  Sets a handler for general FE data pages.

- **set_neo_modes(modes: list)**
  Sets the modes for Neo trainers.

- **set_specific_trainer_data_page_handler(handler: callable)**
  Sets a handler for specific trainer data pages.

- **set_target_power(power: int)**
  Sets the target power output.

- **set_track_resistance(resistance: int)**
  Sets the track resistance level.

- **set_user_configuration(config: dict)**
  Sets the user configuration for the trainer.

- **set_wind_resistance(resistance: int)**
  Sets the wind resistance level.
```

--------------------------------

### RearViewRadarService Methods

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Methods for enabling notifications and setting handlers for radar measurements.

```APIDOC
## RearViewRadarService

### Description
Handles radar measurements for rear-view safety.

### Methods
- `disable_radar_measurement_notifications()`: Disables radar measurement notifications.
- `enable_radar_measurement_notifications()`: Enables radar measurement notifications.
- `set_radar_measurement_handler(handler)`: Sets a handler for radar measurement data.
```

--------------------------------

### BatteryService

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Provides methods for interacting with battery-related services.

```APIDOC
## BatteryService

### Description
Provides methods for interacting with battery-related services.

### Methods
* `get_battery_level()` - Retrieves the current battery level.
```

--------------------------------

### CyclingSpeedCadenceService

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Handles cycling speed and cadence measurements.

```APIDOC
## CyclingSpeedCadenceService

### Description
Handles cycling speed and cadence measurements, including enabling and disabling notifications.

### Methods
* `disable_csc_measurement_notifications()` - Disables notifications for CSC measurements.
```

--------------------------------

### HeartRateService Methods

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Methods for enabling notifications and setting handlers for Heart Rate measurements.

```APIDOC
## HeartRateService

### Description
Manages heart rate measurements and notifications.

### Methods
- `disable_hr_measurement_notifications()`: Disables heart rate measurement notifications.
- `enable_hr_measurement_notifications()`: Enables heart rate measurement notifications.
- `set_hr_measurement_handler(handler)`: Sets a handler for incoming heart rate measurements.
```

--------------------------------

### CyclingPowerService

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Manages cycling power measurements and features.

```APIDOC
## CyclingPowerService

### Description
Manages cycling power measurements and features, allowing users to enable/disable notifications, retrieve feature information, and set measurement handlers.

### Methods
* `disable_cycling_power_measurement_notifications()` - Disables notifications for cycling power measurements.
* `disable_cycling_power_vector_notifications()` - Disables notifications for cycling power vectors.
* `enable_cycling_power_measurement_notifications()` - Enables notifications for cycling power measurements.
* `enable_cycling_power_vector_notifications()` - Enables notifications for cycling power vectors.
* `get_cycling_power_feature()` - Retrieves the cycling power feature information.
* `get_sensor_location()` - Retrieves the sensor location.
* `set_cycling_power_measurement_handler()` - Sets a handler for cycling power measurements.
* `set_cycling_power_vector_handler()` - Sets a handler for cycling power vectors.
```

--------------------------------

### Rizer Methods

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Methods for controlling steering measurements and transmission rates.

```APIDOC
## Rizer

### Description
Provides control over Rizer device functionalities, including steering measurements.

### Methods
- `disable_steering_measurement_notifications()`: Disables steering measurement notifications.
- `enable_steering_measurement_notifications()`: Enables steering measurement notifications.
- `set_center()`: Sets the center position for steering.
- `set_steering_measurement_callback(callback)`: Sets a callback function for steering measurements.
- `set_transmission_rate(rate)`: Sets the transmission rate for the device.
```

--------------------------------

### Tacx Trainer Control Enums

Source: https://zacharyedwardbull.github.io/pycycling/pycycling.html

Enumerations related to Tacx trainer control, including command status and equipment types.

```APIDOC
## Tacx Trainer Control Enums

### Description
Enumerations used in the Tacx trainer control module.

### Enums
- `CommandStatus`:
  - `fail`: Indicates a command failure.
  - `not_supported`: Indicates the command is not supported.
  - `rejected`: Indicates the command was rejected.
  - `success`: Indicates the command was successful.
  - `uninitialized`: Indicates the system is uninitialized.
- `EquipmentType`:
  - `climber`: Represents a climber equipment type.
  - `elliptical`: Represents an elliptical equipment type.
  - `nordic_skier`: Represents a Nordic skier equipment type.
  - `reserved`: Represents a reserved equipment type.
```
Tokens:
Raw