Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ad-ha/mg-saic-ha
MG SAIC Custom Integration for Home Assistant
https://github.com/ad-ha/mg-saic-ha
custom-integration hacs homeassistant homeassistant-custom-component mg saic
Last synced: about 1 month ago
JSON representation
MG SAIC Custom Integration for Home Assistant
- Host: GitHub
- URL: https://github.com/ad-ha/mg-saic-ha
- Owner: ad-ha
- License: mit
- Created: 2024-07-29T20:24:42.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-19T16:49:39.000Z (about 2 months ago)
- Last Synced: 2024-09-30T19:04:29.812Z (about 2 months ago)
- Topics: custom-integration, hacs, homeassistant, homeassistant-custom-component, mg, saic
- Language: Python
- Homepage:
- Size: 76.2 KB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/custom-components/hacs)
[](https://github.com/ad-ha/mg-saic-ha/actions/workflows/validate.yaml)
[](https://github.com/ad-ha/mg-saic-ha/actions/workflows/hassfest.yaml)
# MG/SAIC CUSTOM INTEGRATION
**Important Notes:**
- **Using this integration causes the MG/SAIC mobile app to shut down, as per API requirements, since only one device can be connected at a time. Logging into the mobile app causes this integration to disconnect and fail to set up.**
- This Integration has only been tested on a MG Marvel R model. Please provide feedback on sensors and information for other vehicles.
## INSTALLATION
### HACS (Home Assistant Community Store)
1. Ensure that HACS is installed.
2. Go to HACS
3. On the top right menu select "Custom repositories"
4. On the "Repository" field put the URL https://github.com/ad-ha/mg-saic-ha. On the "Category" select "Integration" and click "ADD"
6. Search for "MG SAIC" and download the repository.
7. Restart Home Assistant.
### Manual Installation
1. Download the latest release from the [MG SAIC Custom Integration GitHub repository](#).
2. Unzip the release and copy the `mg_saic` directory to `custom_components` in your Home Assistant configuration directory.
3. Restart Home Assistant.
## CONFIGURATION
[
](https://my.home-assistant.io/redirect/config_flow_start?domain=mg_saic)
1. Go to Configuration -> Integrations.
2. Click on the "+ Add Integration" button.
3. Search for "MG SAIC" and follow the instructions to set up the integration.
4. Select your type of account (email or phone), enter the details and select your region (EU, Asia, China)
5. Once connected to the API, a list of available VINs associated with your account will be shown. Select the vehicle that you want to integrate and finish the process.
You may add additional vehicles by following the same steps as above.
## SENSORS AVAILABLE
The MG/SAIC Custom Integration provides the following sensors and binary sensors:
### SENSORS
#### General
- Brand
- Model
- Model Year
- Mileage
- Fuel Level
- Fuel Range
- EV SOC
- Electric Range
- Battery Voltage
- HVAC Status
- Interior Temperature
- Exterior Temperature
#### Tyre Pressure
- Front Left Tyre Pressure
- Front Right Tyre Pressure
- Rear Left Tyre Pressure
- Rear Right Tyre Pressure
#### Charging Data
- Charging Status
- Charging Voltage
- Charging Current
- Charging Power
- Estimated Range After Charging
- Charging Target SOC
- Charging Duration
- Remaining Charging Time
- Added Electric Range
- Power Usage Since Last Charge
- Mileage Since Last Charge
### BINARY SENSORS
#### Doors
- Driver Door
- Passenger Door
- Rear Left Door
- Rear Right Door
- Bonnet Status
- Boot Status
#### Windows
- Driver Window
- Passenger Window
- Rear Left Window
- Rear Right Window
- Sun Roof Status
#### Others
- Lock Status
- Charging Gun Status
### SERVICES
- Lock Vehicle
- Unlock Vehicle
- Start AC
- Stop AC
- Open Tailgate
- Tigger Find My Car Alarm
- Start Charging (sometimes this service fails)
- Stop Charging
- Defrost Rear Window
- Defrost Windshield
- Control Heated Seats
## Version History
```
0.2.1
- Revised vehicle type identification mechanics and conditions - closes SOC not showing in HA #6
- Added new step to config_flow to allow users to select the correct vehicle type if the integration fails to do so based on API data - closes SOC not showing in HA #6
- Added configuration options to the integration to manually change the update intervals.
- Revised translations
```
```
0.2.0
- Revised mechanics for connection with API and data retrieval
- Services testing and adjusting to API requirements
- Renamed and revised sensor data and info
- Revise units for sensors and adapting all sensors to SensorDeviceClass from Home Assistant
- Revise Unique ID generation for all sensors
- Revise Login method to avoid blocking calls during startup
- Improve detection and discard of "Generic Responses" during API setup and updates
- Improve vehicle type detection on integration setup.
```
```
0.1.0
- Refactor code to work with data coordinator
- Revised mechanics for connection with API and data retrieval
- Update saic-python-client-ng requirements to version 0.2.3
- Added new sensors for charging data
- Renamed and revised sensor data and info
- Revise config_flow to allow login with phone and email
- Initial implementation of services (some services still not available, but are implemented as a proof of concept). _Feedback on this will be helpful_
- Change update interval to 5 minutes once charging is detected
- Refactor API responses and values as needed. Charging sensors only display data if Charging is Active, otherwise 0 will be displayed
- Fuel Level, Fuel Range, EV State of Charge and Electric Range are vehicle dependent. Add logic to determine the vehicle type and show sensors accordingly.
```
```
0.0.2
- Revised mechanics for connection with API
- Added new sensors (Brand, Model and MY)
- Rename sensors based on Brand and Model
- Rename sensors to have them grouped by type (windows, doors, tyres...)
- Revise config_flow (_login with phone still not working and unavailable_)
- Initial trialing for charging details
```
```
0.0.1
- Initial release
```
## TO-DO
- ~~Implement initial services for Locks action, AC control and ancillary services.~~
- ~~Implement charging detection and corresponding sensors.~~
- Check API details for energy usage and stats, adding additional sensors.
- ~~Check implementation against other EV/PHEV models.~~
- Add possibility to display metric or imperial data, including tyres' pressure.
## Contributing
Contributions are welcome! If you have any suggestions or find any issues, please open an [issue](https://github.com/ad-ha/mg-saic-ha/issues) or a [pull request](https://github.com/ad-ha/mg-saic-ha/pulls).
## Credits
This integration was made possible thanks to the [saic-ismart-client-ng](https://github.com/SAIC-iSmart-API/saic-python-client-ng) repository and its developers/contributors.
## License
This project is licensed under the MIT License. See the LICENSE file for details.
## Disclaimer
THIS PROJECT IS NOT IN ANY WAY ASSOCIATED WITH OR RELATED TO THE SAIC MOTOR OR ANY OF ITS SUBSIDIARIES. The information here and online is for educational and resource purposes only and therefore the developers do not endorse or condone any inappropriate use of it, and take no legal responsibility for the functionality or security of your devices.