ad-ha / mg-saic-ha

MG SAIC Custom Integration for Home Assistant
MIT License
2 stars 0 forks source link
custom-integration hacs homeassistant homeassistant-custom-component mg saic

hacs_badge GitHub Release (latest SemVer including pre-releases) GitHub Downloads (all assets, latest release)

HACS Action Hassfest

image

MG/SAIC CUSTOM INTEGRATION

Buy Me A Coffee

Important Notes:

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"

    image

  4. On the "Repository" field put the URL https://github.com/ad-ha/mg-saic-ha. On the "Category" select "Integration" and click "ADD"

    image

  5. Search for "MG SAIC" and download the repository.

  6. 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

  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

Tyre Pressure

Charging Data

BINARY SENSORS

Doors

Windows

Others

SERVICES

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

Contributing

Contributions are welcome! If you have any suggestions or find any issues, please open an issue or a pull request.

Credits

This integration was made possible thanks to the saic-ismart-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.