Code Monkey home page Code Monkey logo

mg-saic-ha's Introduction

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

HACS Action Hassfest

image

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" 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 SENSORS

  • Brand
  • Model
  • Model Year
  • Mileage
  • Fuel Level
  • Fuel Range
  • EV SOC
  • Electric Range
  • Battery Voltage
  • HVAC Status
  • Interior Temperature
  • Exterior Temperature

TYRE PRESSURE SENSORS

  • Front Left Tyre Pressure
  • Front Right Tyre Pressure
  • Rear Left Tyre Pressure
  • Rear Right Tyre Pressure

CHARGING DATA SENSORS

  • Charging Status
  • Charging Voltage
  • Charging Current
  • Charging Power
  • Estimated Range After Charging
  • Charging Current Limit
  • 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

Version History

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

mg-saic-ha's People

Contributors

ad-ha avatar

Stargazers

Thibault Ehrhart avatar  avatar

Watchers

 avatar  avatar

mg-saic-ha's Issues

Login failed

Hi

I'm trying to use this integration and it is not possible. When I try to log in I get error “Authentication error, please verify your credentials”.

I've tried logging in with email and phone number. The credentials are correct, if I close the session on the mobile I can login without problem with those same credential. I am using the europe location, I am in Spain.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.