ZERO Motocycles Integrations in Home Assistant

olis · June 8, 2020, 10:05pm

Like a TESLA you can integrate ZERO Motocycles in Home Assistant:
Turns out you can also use a plain URL in your browser :
https://mongol.brono.com/mongol/api.php?commandname=get_units&format=json&user= yourusername &pass= yourpass

to get your unitnumber you have to use in the URL below

https://mongol.brono.com/mongol/api.php?commandname=get_last_transmit&format=json&user= yourusername &pass= yourpass &unitnumber= 0000000

obviously you would have to alter :
yourusername to the username you have entered in the NextGen app
yourpass to the password you ised in the nextgen app

you can change the format=json to format is CSV for CSV response, or to format=XML for XML respone, or to format=HTTP for also comma seperated values. And possibly there are more formats you can use.

In HomeAssistant coniguration.yaml:

ZERO SR/F

platform: rest
name: Zero SR/F
resource: https://mongol.brono.com/mongol/api.php?commandname=get_last_transmit&format=json&user=USERNAME&pass=TopSecret123&unitnumber=123456
scan_interval: 120
json_attributes:
- unitnumber
- name
- mileage
- main_voltage
- longitude
- latitude
- altitude
- soc
- address
- tipover
- charging
- chargecomplete
- pluggedin
- chargingtimeleft
  value_template: ‘{{ states.sensor.zero_sr_f.attributes[“address”] }}’
platform: template
sensors:
zero_unitnumber:
friendly_name: Unitnummer
value_template: ‘{{ states.sensor.zero_sr_f.attributes[“unitnumber”] }}’
zero_name:
friendly_name: Seriennummer
value_template: ‘{{ states.sensor.zero_sr_f.attributes[“name”] }}’
zero_mileage:
friendly_name: Kilometerstand
icon_template: mdi:counter
value_template: ‘{{ states.sensor.zero_sr_f.attributes[“mileage”] }}’
unit_of_measurement: ‘km’

TripleJ · June 23, 2022, 6:11pm

I am not able to copy paste this into configuration.yaml it says duplicate keys errors. Is there a way you can share it in proper code form and indention. Or is it because it’s and old way of doing this and it needs to be re-written. Just stumbled on this would be cool to have this data in HA.
Thanks in advance.

olis · June 24, 2022, 7:33am

sensor:
  # ZERO SR/F
  - platform: rest
    name: Zero SR/F
    resource: https://mongol.brono.com/mongol/api.php?commandname=get_last_transmit&format=json&user=USERNAME&pass=PASSWORD&unitnumber=UNITNUMBER
    scan_interval: 90
    json_attributes:
      - unitnumber
      - name
      - mileage
      - software_version
      - main_voltage
      - longitude
      - latitude
      - altitude
      - soc
      - address
      - tipover
      - charging
      - chargecomplete
      - pluggedin
      - chargingtimeleft
    value_template: '{{ states.sensor.zero_sr_f.attributes["address"] }}'
  - platform: template
    sensors:
      zero_unitnumber:
        friendly_name: Unitnummer
        value_template: '{{ states.sensor.zero_sr_f.attributes["unitnumber"] }}'
      zero_name:
        friendly_name: Seriennummer
        value_template: '{{ states.sensor.zero_sr_f.attributes["name"] }}'
      zero_mileage:
        friendly_name: Meilenstand
        icon_template: mdi:counter
        value_template: '{{ states.sensor.zero_sr_f.attributes["mileage"] }}'
        unit_of_measurement: 'miles'
      zero_km:
        friendly_name: Odometer
        icon_template: mdi:counter
        value_template: '{{ (states.sensor.zero_sr_f.attributes["mileage"] | float * 1.08194939878576) | round(2) }}'
        unit_of_measurement: 'km'
      zero_software_version:
        friendly_name: Zero SW-Version
        icon_template: mdi:microsoft-windows-classic
        value_template: '{{ states.sensor.zero_sr_f.attributes["software_version"] }}'
      zero_main_voltage:
        friendly_name: Zero Batterie
        icon_template: mdi:car-battery
        value_template: '{{ states.sensor.zero_sr_f.attributes["main_voltage"] }}'
        unit_of_measurement: 'V'
      zero_longitude:
        friendly_name: Zero Longitude
        value_template: '{{ states.sensor.zero_sr_f.attributes["longitude"] }}'
      zero_latitude:
        friendly_name: Zero Latitude
        value_template: '{{ states.sensor.zero_sr_f.attributes["latitude"] }}'
      zero_altitude:
        friendly_name: Zero Altitude
        value_template: '{{ states.sensor.zero_sr_f.attributes["altitude"] }}'
        unit_of_measurement: 'm ü. M.'
      zero_soc:
        friendly_name: Akkustand
        value_template: '{{ states.sensor.zero_sr_f.attributes["soc"] }}'
        unit_of_measurement: '%'
        device_class: battery
      zero_address:
        friendly_name: Adresse
        icon_template: mdi:map-marker
        value_template: '{{ states.sensor.zero_sr_f.attributes["address"] }}'
      zero_tipover:
        friendly_name: Km seit aufgeladen
        value_template: '{{ states.sensor.zero_sr_f.attributes["tipover"] }}'
        unit_of_measurement: 'km'
      zero_charging:
        friendly_name: Laden
        value_template: '{{ states.sensor.zero_sr_f.attributes["charging"] }}'
      zero_chargecomplete:
        friendly_name: Laden beendet
        value_template: '{{ states.sensor.zero_sr_f.attributes["chargecomplete"] }}'
      zero_pluggedin:
        friendly_name: Eingesteckt
        value_template: '{{ states.sensor.zero_sr_f.attributes["pluggedin"] }}'
      zero_chargingtimeleft:
        friendly_name: Laden beendet in
        value_template: '{{ states.sensor.zero_sr_f.attributes["chargingtimeleft"] }}'
        icon_template: mdi:clock-end
        unit_of_measurement: 'Minuten'

olis · June 24, 2022, 9:20am

Change:
user=Your USERNAME
pass=Your PASSWORD
unitnumber=Your UNITNUMBER

TripleJ · June 24, 2022, 11:46am

Thanks man, for taking time to change the layout, much appreciated. Look forward to test this later.
Perhaps I should look into learning how to create something for HACS so there be a nice integration for Zero stuff.
Update: Works great. I just don’t have no luck saying that’s it’s home, despite my app on my phone says I am home, so it knows!
also is this Zero’s own public API we are calling or some third party in front ?
How did you create the card ‘Wo ist Zero’ It’s cool to know as well.
Thanks again.

mobiustorr · June 30, 2022, 12:12am

I’m running into an error every time I try to use the link you provided. It keeps giving me “601 Unauthorized user (…)”. I’m using the same username for my Zero NG app. Any ideas how to fix that? Thanks.

olis · June 30, 2022, 1:53pm

Be sure you have the right Unitnumber. To get this Number use this link in a borwser:

https://mongol.brono.com/mongol/api.php?commandname=get_units&format=json&user=YOURUSER&pass=YOURPASS

Change:
YOURUSER=Your USERNAME
YOURPASS=Your PASSWORD

so you can get the Unitnumber (6 digit)

Then use this Link:

https://mongol.brono.com/mongol/api.php?commandname=get_last_transmit&format=json&user=YOURUSER&pass=YOURPASS&unitnumber=UNITNUMBER

mobiustorr · June 30, 2022, 4:31pm

I’m still getting an error 601 authorized user with that link.

My username in the NG app is an email, would that be causing the problem?

LoremIpsum · July 21, 2022, 6:47pm

I created a package file to bundle up all of the sensors plus device tracker automation I’ve created, based on the information provided in this thread, and tossed it up on GitHub as a Gist.

gist.github.com

https://gist.github.com/crkochan/7650fbd30a9c0a4ff8f73311bdb131fa

zero_motorcycle.yaml

sensor:
  - platform: rest
    name: Zero SR/S
    unique_id: 1981693c-d77b-4a0a-b835-f880af747cd7
    json_attributes:
      - address
      - altitude
      - analog1
      - analog3
      - chargecomplete

This file has been truncated. show original

zero_motorcycle_package.md

## Requirements
You will need to have the ability to add files to your Home Assistant configuration directory, and be comfortable with manually editing YAML files.

### Add account information to `secrets.yaml`

You must add a line in your `secrets.yaml` file: `zero_api_url: 'https://mongol.brono.com/mongol/api.php?commandname=get_last_transmit&format=json&user=<e-mail>&pass=<password>&unitnumber=<number>'`

Add in your e-mail, password, and unit number in the appropriate spot.

To find your unit number, you can use a slightly different URL: `https://mongol.brono.com/mongol/api.php?commandname=get_units&format=json&user=<e-mail>&pass=<password>`

This file has been truncated. show original

The markdown file explains how to install it, and how to enable the Package function in Home Assistant if you haven’t already.

I figure this is the next best thing to an actual integration in Home Assistant, since I keep bouncing off the Python every time I try to write one. I can’t quite wrap my head around dealing with asyncio objects.

Vinx · May 27, 2023, 7:27pm

Works like a charm, thanks a lot!
I’ve combined this with the Google Sheets integration. Wtih an added entity (see below) and a couple of automations I’m now keeping track of every trip I make (address from-to, milage, etc), removing the need to do this by hand.

- name: Zero driving
        unique_id: zero_driving
        state: "{{states('sensor.zero_speed')|float > 0 and states('binary_sensor.zero_on')}}"
        device_class: running
        delay_on:
          minutes: 1
        delay_off:
          minutes: 5
        attributes:
          unitnumber: "{{ state_attr('sensor.zero_sr_s', 'unitnumber') }}"

@mobiustorr I had problems logging in as well. Ended up having to change my password, but that solved it.

hans2183 · September 6, 2023, 8:08am

Thanks for sharing your implementation. I’ve made an integration for this including device_tracker. That way you can just add the git repo to hacs and then add it without having to worry about the API or sensor templates.

The only reason it’s not submitted to the default repository is because that requires me to submit branding first and I know from earlier experience that zero actively kills anything not official.

eLindemann · March 15, 2024, 6:41pm

Reviving this old thread in case future nerds run into this issue like we did.

My username in the NG app is an email, would that be causing the problem?

In short; yes that is exactly what’s causing your problem. Fortunately the fix is simple, and obvious after I thought about it.

You need to utilize URL encoding for your ASCII symbols. So if your email address has an “@” then you need to replace it with “%40”. So if your login is [email protected] then you would need to use: &user=username%40example.com

I did the same thing for the symbols in my password as well. At any rate, it works!

FraGuBu · August 8, 2024, 1:58pm

Why does the mileage have to be multiplied by this strange factor?

olis · August 19, 2024, 9:44pm

convert miles zu kilometers

Vinx · September 2, 2024, 2:47pm

In what context is that the conversion from miles to km? If it were, I’d expect 1.609344.
Then again, I do recognize the strange factor between the value in the api and on the motor bike. For me it’s a slightly different factor though (1.0634)
Bike on miles setting: 6455
Bike on km setting: 10388
Api mileage: 9768.45
So what is the unit for the api mileage? Reading from the ElectricMotorcycleForum they suggest it could be GPS mileage rather than actual mileage.

chris94440 · November 11, 2024, 9:52am

Hello
I think you are right… as mentionned in this git (GitHub - s28400/zmci-tool: Non official zero-motorcycle cloud interface tool) the system is based on https://www.starcomsystems.com/ … thats why mileage are not in phase as mobile app mileage or motorcylces mileage …
My motorcycle is a test motorcycle and i don’t have the same mileage between : motorcycles, mobile app and api …
did you find a solution to have real motorcycle’s values ?
Best regards
Christophe

Vinx · November 16, 2024, 8:01pm

I experimented with an alternative approach, which turns out to be more precise. It needs some technical knowledge though.

Read the get_history api for each day (is only available for the last year unfortunately)
For each (json) line and the next, pass the coordinates to the Google Distance Matrix API. This API determines the road distance between coordinates.

In a certain period I came up with these numbers:

Distance meter went up in 3893. This is the value we’d want
The Zero API gives me 3691 from the starcom device. This is an error of 5,5%
The sum from the Google Distance Matrix API gives me 3998. This is an error of 2,7%.

Even though it is much more precise, It’s still a workaround. I’ll monitor if this is a constant factor, if so I could compensate with that factor and have an even more precise estimate.