From 38361278d20d568d4802d50947816d0617480520 Mon Sep 17 00:00:00 2001 From: Will Adler Date: Sat, 14 Dec 2024 20:02:21 -0500 Subject: [PATCH] documentation updates --- README.md | 10 +++++----- custom_components/leafspy/strings.json | 2 +- custom_components/leafspy/translations/en.json | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 559b7f6..0f33740 100644 --- a/README.md +++ b/README.md @@ -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 | diff --git a/custom_components/leafspy/strings.json b/custom_components/leafspy/strings.json index 5eaae9b..4c8bec8 100644 --- a/custom_components/leafspy/strings.json +++ b/custom_components/leafspy/strings.json @@ -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": { diff --git a/custom_components/leafspy/translations/en.json b/custom_components/leafspy/translations/en.json index 5eaae9b..4c8bec8 100644 --- a/custom_components/leafspy/translations/en.json +++ b/custom_components/leafspy/translations/en.json @@ -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": {