Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
wtadler committed Dec 15, 2024
1 parent bc64f16 commit 3836127
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,25 +43,25 @@ _See [LeafSpy manual](https://leafspy.com/wp-content/uploads/2024/04/LeafSpy-Hel
### Sensors
| Entity ID | Unit reported by LeafSpy | Note |
| :-- | :-- | :-- |
| sensor.leaf_ambient_temperature | °C / °F | Unit adjustable in HA UI BUT ALSO... |
| sensor.leaf_ambient_temperature | °C (You must set this in the LeafSpy app) | Unit adjustable in HA UI |
| sensor.leaf_battery_capacity | Ah | |
| sensor.leaf_battery_conductance | % | Referred to as Hx |
| sensor.leaf_battery_conductance | % | Referred to as Hx in the LeafSpy manual |
| sensor.leaf_battery_current | A | |
| sensor.leaf_battery_gids | Gids | |
| sensor.leaf_battery_health | % | |
| sensor.leaf_battery_state_of_charge | % | |
| sensor.leaf_battery_temperature | °C / °F | Unit adjustable in HA UI BUT ALSO... |
| sensor.leaf_battery_temperature | °C (You must set this in the LeafSpy app) | Unit adjustable in HA UI |
| sensor.leaf_battery_voltage | V | |
| sensor.leaf_charge_mode | --- | |
| sensor.leaf_charge_power | W | Not very accurate. For example, when charging via level 2 charging, it just guesses 6,000 W. |
| sensor.leaf_elevation | m | Unit adjustable in HA UI |
| sensor.leaf_front_wiper | --- | Not known if Leaf Spy reports this. File an issue if you see info here. |
| sensor.leaf_motor_speed | RPM | |
| sensor.leaf_odometer | km | Unit adjustable in HA UI |
| sensor.leaf_odometer | km | You must indicate in LeafSpy whether your car reports in km or mi. Unit adjustable in HA UI |
| sensor.leaf_phone_battery | % | |
| sensor.leaf_plug | --- | Reports "Not plugged", "Partial Plugged", or "Plugged" |
| sensor.leaf_sequence_number | --- | A number that increments with each report from Leaf Spy |
| sensor.leaf_speed | km/h | Unit adjustable in HA UI |
| sensor.leaf_temperature_units | --- | Shows whether LeafSpy is set to C or F. [Maybe no need to expose?] |
| sensor.leaf_trip_number | --- | Tracks total number of trips taken |
| sensor.leaf_vin | --- | Car unique identifier |

Expand Down
2 changes: 1 addition & 1 deletion custom_components/leafspy/strings.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"one_instance_allowed": "You may have only one instance of Leaf Spy installed, and you appear to have installed one already."
},
"create_entry": {
"default": "Open the Leaf Spy app, go to `'Menu'` -> `'Settings'` and scroll down to `'Server'`. \nChange the following settings:\n - `'Enable'`: Yes\n - `'Send Interval'` can be whatever you prefer.\n - `'ID'`: `'(Car Name)'`\n - `'PW'`: {secret}\n - `'Http'` or `'Https'` depending on the access to your Home Assistant install.\n - `'URL'`: {url} - Note: **Do not** add http or https to the URL."
"default": "Open the LeafSpy app, go to `'Menu'` -> `'Settings'`.\n - Set `'Units'` to `'°C'`.\n - Enable `'Convert Outside Temperatures'`.\n - Scroll down to the `'Server'` section. Change the following settings:\n - `'Enable'`: Yes\n - `'Send Interval'` can be whatever you prefer.\n - `'ID'`: `'(Car Name)'`\n - `'PW'`: {secret}\n - `'Http'` or `'Https'` depending on the access to your Home Assistant install.\n - `'URL'`: {url} - Note: **Do not** add http or https to the URL."
},
"step": {
"user": {
Expand Down
2 changes: 1 addition & 1 deletion custom_components/leafspy/translations/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"one_instance_allowed": "You may have only one instance of Leaf Spy installed, and you appear to have installed one already."
},
"create_entry": {
"default": "Open the Leaf Spy app, go to `'Menu'` -> `'Settings'` and scroll down to `'Server'`. \nChange the following settings:\n - `'Enable'`: Yes\n - `'Send Interval'` can be whatever you prefer.\n - `'ID'`: `'(Car Name)'`\n - `'PW'`: {secret}\n - `'Http'` or `'Https'` depending on the access to your Home Assistant install.\n - `'URL'`: {url} - Note: **Do not** add http or https to the URL."
"default": "Open the LeafSpy app, go to `'Menu'` -> `'Settings'`.\n - Set `'Units'` to `'°C'`.\n - Enable `'Convert Outside Temperatures'`.\n - Scroll down to the `'Server'` section. Change the following settings:\n - `'Enable'`: Yes\n - `'Send Interval'` can be whatever you prefer.\n - `'ID'`: `'(Car Name)'`\n - `'PW'`: {secret}\n - `'Http'` or `'Https'` depending on the access to your Home Assistant install.\n - `'URL'`: {url} - Note: **Do not** add http or https to the URL."
},
"step": {
"user": {
Expand Down

0 comments on commit 3836127

Please sign in to comment.