bonneguldberg/ha-mysmartbike_ble
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

adjust readme

Browse Source
This commit is contained in:
Rene Nulsch
2025-11-21 22:50:04 +01:00
parent 4e66d2563b
commit 7265d939dc
1 changed files with 5 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -16
View File
@@ -3,7 +3,7 @@
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration) [![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration)
[![GitHub release](https://img.shields.io/github/release/renenulschde/ha-mysmartbike-ble.svg)](https://github.com/renenulschde/ha-mysmartbike-ble/releases) [![GitHub release](https://img.shields.io/github/release/renenulschde/ha-mysmartbike-ble.svg)](https://github.com/renenulschde/ha-mysmartbike-ble/releases)
Home Assistant custom component for E-Bikes with Mahle SmartBike systems (X35+, ebikemotion) via Bluetooth Low Energy (BLE). Home Assistant custom component for E-Bikes with Mahle SmartBike systems (X25, X35+, ebikemotion, ...) via Bluetooth Low Energy (BLE).
Many premium E-Bike brands use Mahle drive systems and the MySmartBike app for connectivity. This integration works with bikes from various manufacturers including Schindelhauer, Orbea, Bianchi, Pinarello, Scott, and others that use the Mahle BLE protocol. Many premium E-Bike brands use Mahle drive systems and the MySmartBike app for connectivity. This integration works with bikes from various manufacturers including Schindelhauer, Orbea, Bianchi, Pinarello, Scott, and others that use the Mahle BLE protocol.
@@ -24,7 +24,7 @@ This integration provides real-time monitoring of your E-Bike through Bluetooth
### Connection Control ### Connection Control
- **Connection Switch** - Control the BLE connection to your E-Bike - **Connection Switch** - Control the BLE connection to your E-Bike
- ⚠️ **IMPORTANT WARNING**: Turning off this switch will disconnect from the bike and **the bike will shut down after approximately 5 minutes**. You must manually turn the bike back on or connect it to power to reconnect! - Turning off this switch will disconnect from the bike and **the bike will shut down after approximately 5 minutes**. You must manually turn the bike back on or connect it to power to reconnect!
- Use this switch to save energy when you don't need active monitoring - Use this switch to save energy when you don't need active monitoring
- The bike will automatically turn off about 5 minutes after disconnection to conserve battery - The bike will automatically turn off about 5 minutes after disconnection to conserve battery
@@ -44,7 +44,6 @@ This integration provides real-time monitoring of your E-Bike through Bluetooth
- **Odometer** (km) - **Odometer** (km)
- **Range** (km) - **Range** (km)
- **Light Status** - **Light Status**
- **EBM Status**
### Device Information ### Device Information
The integration automatically retrieves and displays: The integration automatically retrieves and displays:
@@ -53,8 +52,9 @@ The integration automatically retrieves and displays:
## Requirements ## Requirements
- Home Assistant 2024.1.0 or newer - Home Assistant 2024.1.6 or newer
- Bluetooth adapter with BLE support - Bluetooth adapter with BLE support
- Bluetooth proxies with active connections are supported (ex. EspHome) - Shelly is not support as active direct connections are not possible.
- E-Bike with Mahle SmartBike system (compatible with MySmartBike or ebikemotion app) - E-Bike with Mahle SmartBike system (compatible with MySmartBike or ebikemotion app)
## Installation ## Installation
@@ -97,7 +97,7 @@ The integration will automatically discover iWoc devices in range via Bluetooth.
- Make sure your E-Bike is turned on and in range - Make sure your E-Bike is turned on and in range
- Check that Bluetooth is enabled on your Home Assistant host - Check that Bluetooth is enabled on your Home Assistant host
- Verify that the device name starts with "iWoc" - Verify that the device name starts with "iWoc" (please report other device names)
### Connection issues ### Connection issues
@@ -122,22 +122,11 @@ The integration will automatically discover iWoc devices in range via Bluetooth.
3. Turn on the "Connection" switch in Home Assistant 3. Turn on the "Connection" switch in Home Assistant
- **Use case**: Turn off the connection when you don't need monitoring to save your bike's battery - **Use case**: Turn off the connection when you don't need monitoring to save your bike's battery
## Development
This integration is based on the BLE protocol from Mahle SmartBike systems.
### Contributing ### Contributing
Contributions are welcome! Please feel free to submit a Pull Request. Contributions are welcome! Please feel free to submit a Pull Request.
### Protocol Documentation
The integration parses the following message types:
- Battery messages (voltage, SoC, current, temperature)
- Motor messages (speed, power, torque, assist level)
- EBM messages (odometer, range, light status)
- Assist level messages
## License ## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.