Version: 1.0.2 20241121 - Added cryptocurrency_id, cryptocurrency_name, cryptocurrency_symbol and currency_name to attributes

THIS WILL BREAK current sensors because of the cryptocurrency_names to cryptocurrency_ids change!!!

Author: heyajohnny

README.md

@@ -39,27 +39,35 @@ The next step is to add cryptoinfo sensors to your Home Assistant:
 ![image](https://github.com/user-attachments/assets/8ad3d15c-78ce-4c0a-892c-f0a967595f9d)
 
 ### Properties
+```
 - Identifier                                Unique name for the sensor
-- Cryptocurrency names                      One or more of the 'id' values (seperated by a , character) that you can find on this <a href='https://api.coingecko.com/api/v3/coins/list' target='_blank'>page</a>
-- Multipliers                               The number of coins/tokens (seperated by a , character). The number of Multipliers must match the number of Cryptocurrency names
+- Cryptocurrency id's                       One or more of the 'id' values (seperated by a , character) that you can find on this <a href='https://api.coingecko.com/api/v3/coins/list' target='_blank'>page</a>
+- Multipliers                               The number of coins/tokens (seperated by a , character). The number of Multipliers must match the number of Cryptocurrency id's
 - Currency name                             One of the currency names that you can find on this <a href='https://api.coingecko.com/api/v3/simple/supported_vs_currencies' target='_blank'>page</a>
 - Unit of measurement                       You can use a currency symbol or you can make it empty. You can find some symbols on this <a href='https://en.wikipedia.org/wiki/Currency_symbol#List_of_currency_symbols_currently_in_use' target='_blank'>page</a>
 - Update frequency (minutes)                How often should the value be refreshed? Beware of the <a href='https://support.coingecko.com/hc/en-us/articles/4538771776153-What-is-the-rate-limit-for-CoinGecko-API-public-plan' target='_blank'>CoinGecko rate limit</a> when using multiple sensors
 - Minimum time between requests (minutes)   The minimum time between the other sensors and this sensor to make a data request to the API. (This property is shared and the same for every sensor). You can set this value to 0 if you only use 1 sensor
+```
 
 ### Attributes
 The entities have some important attributes:
-- last_update         This will return the date and time of the last update
-- base_price          This will return the price of 1 coin / token in 'currency_name'(default = "usd") of the 'cryptocurrency_name'
-- multiplier          This will return the number of coins / tokens
-- 24h_volume          This will return the 24 hour volume in 'currency_name'(default = "usd") of the 'cryptocurrency_name'(default = "bitcoin")
-- 1h_change           This will return the 1 hour change in percentage of the 'cryptocurrency_name'(default = "bitcoin")
-- 24h_change          This will return the 24 hour change in percentage of the 'cryptocurrency_name'(default = "bitcoin")
-- 7d_change           This will return the 7 day change in percentage of the 'cryptocurrency_name'(default = "bitcoin")
-- 30d_change          This will return the 30 day change in percentage of the 'cryptocurrency_name'(default = "bitcoin")
-- market_cap          This will return the total market cap of the 'cryptocurrency_name'(default = "bitcoin") displayed in 'currency_name'(default = "usd")
-- circulating_supply  This will return the circulating supply of the 'cryptocurrency_name'(default = "bitcoin")
-- total_supply        This will return the total supply of the 'cryptocurrency_name'(default = "bitcoin")
+```
+- last_update           This will return the date and time of the last update
+- cryptocurrency_id     This will return the cryptocurrency id
+- cryptocurrency_name   This will return the cryptocurrency name
+- cryptocurrency_symbol This will return the cryptocurrency symbol
+- currency_name         This will return the currency name
+- base_price            This will return the price of 1 coin / token in 'currency_name'(default = "usd") of the 'cryptocurrency_id'
+- multiplier            This will return the number of coins / tokens
+- 24h_volume            This will return the 24 hour volume in 'currency_name'(default = "usd") of the 'cryptocurrency_id'(default = "bitcoin")
+- 1h_change             This will return the 1 hour change in percentage of the 'cryptocurrency_id'(default = "bitcoin")
+- 24h_change            This will return the 24 hour change in percentage of the 'cryptocurrency_id'(default = "bitcoin")
+- 7d_change             This will return the 7 day change in percentage of the 'cryptocurrency_id'(default = "bitcoin")
+- 30d_change            This will return the 30 day change in percentage of the 'cryptocurrency_id'(default = "bitcoin")
+- market_cap            This will return the total market cap of the 'cryptocurrency_id'(default = "bitcoin") displayed in 'currency_name'(default = "usd")
+- circulating_supply    This will return the circulating supply of the 'cryptocurrency_id'(default = "bitcoin")
+- total_supply          This will return the total supply of the 'cryptocurrency_id'(default = "bitcoin")
+```
 
 Template example for usage of attributes.
 This example creates a new sensor with the attribute value '24h_volume' of the sensor 'sensor.cryptoinfo_main_wallet_ethereum_eur':

Version

@@ -17,4 +17,5 @@ Version: 0.1.5 20230323 - Use floating point precision for the update interval
 Version: 0.1.6 20230323 - Use floating point precision for the update interval (typo fix)
 Version: 0.1.7 20230330 - Better exception
 Version: 1.0.0 20241119 - Complete refactor
-Version: 1.0.1 20241120 - Updated hacs.json + removed multiplier from identifier
+Version: 1.0.1 20241120 - Updated hacs.json + removed multiplier from identifier
+Version: 1.0.2 20241121 - Added cryptocurrency_id, cryptocurrency_name, cryptocurrency_symbol and currency_name to attributes

custom_components/cryptoinfo/config_flow.py

@@ -15,7 +15,7 @@
 
 from .const.const import (
     _LOGGER,
-    CONF_CRYPTOCURRENCY_NAMES,
+    CONF_CRYPTOCURRENCY_IDS,
     CONF_CURRENCY_NAME,
     CONF_ID,
     CONF_MIN_TIME_BETWEEN_REQUESTS,
@@ -29,9 +29,9 @@
     "description_help": "For more information, see the <a href='https://github.com/heyajohnny/cryptoinfo' target='_blank'>documentation</a>.",
     "id_help": "Unique name for the sensor",
     "currency_name_help": "One of the currency names in <a href='https://api.coingecko.com/api/v3/simple/supported_vs_currencies' target='_blank'>this list</a>.",
-    "cryptocurrency_names_help": "The 'id' values from one or more of the coins/tokens in <a href='https://api.coingecko.com/api/v3/coins/list' target='_blank'>this list</a>. seperated by , characters",
+    "cryptocurrency_ids_help": "The 'id' values from one or more of the coins/tokens in <a href='https://api.coingecko.com/api/v3/coins/list' target='_blank'>this list</a>. seperated by , characters",
     "unit_of_measurement_help": "Do you want to use a currency symbol? (<a href='https://en.wikipedia.org/wiki/Currency_symbol#List_of_currency_symbols_currently_in_use' target='_blank'>Symbol list</a>)",
-    "multipliers_help": "The number of coins/tokens (seperated by a , character). The number of Multipliers must match the number of Cryptocurrency names",
+    "multipliers_help": "The number of coins/tokens (seperated by a , character). The number of Multipliers must match the number of Cryptocurrency id's",
     "update_frequency_help": "How often should the value be refreshed? Beware of the <a href='https://support.coingecko.com/hc/en-us/articles/4538771776153-What-is-the-rate-limit-for-CoinGecko-API-public-plan' target='_blank'>CoinGecko rate limit</a> when tracking multiple cryptocurrencies.",
     "min_time_between_requests_help": "The minimum time between the other entities and this entity to make a data request to the API. (This property is shared and the same for every entity)",
 }
@@ -45,17 +45,17 @@ def _validate_input(self, user_input: dict[str, Any]) -> dict[str, str]:
         errors = {}
 
         # Split and clean the values
-        crypto_names = [
-            name.strip() for name in user_input[CONF_CRYPTOCURRENCY_NAMES].split(",")
+        crypto_ids = [
+            name.strip() for name in user_input[CONF_CRYPTOCURRENCY_IDS].split(",")
         ]
         multipliers = [mult.strip() for mult in user_input[CONF_MULTIPLIERS].split(",")]
 
         # Check if the counts match
-        if len(crypto_names) != len(multipliers):
+        if len(crypto_ids) != len(multipliers):
             return {
                 "base": "mismatch_values",
                 "count_context": {
-                    "crypto_count": len(crypto_names),
+                    "crypto_count": len(crypto_ids),
                     "multiplier_count": len(multipliers),
                 },
             }
@@ -116,8 +116,8 @@ async def _redo_configuration(
             {
                 vol.Optional(CONF_ID, default=entry_data[CONF_ID]): str,
                 vol.Required(
-                    CONF_CRYPTOCURRENCY_NAMES,
-                    default=entry_data[CONF_CRYPTOCURRENCY_NAMES],
+                    CONF_CRYPTOCURRENCY_IDS,
+                    default=entry_data[CONF_CRYPTOCURRENCY_IDS],
                 ): str,
                 vol.Required(
                     CONF_CURRENCY_NAME, default=entry_data[CONF_CURRENCY_NAME]
@@ -162,7 +162,7 @@ async def async_step_user(self, user_input: dict[str, Any] | None = None):
         # Use user_input values as defaults if they exist, otherwise use the original defaults
         defaults = {
             CONF_ID: "Main btc stash",
-            CONF_CRYPTOCURRENCY_NAMES: "bitcoin, ethereum",
+            CONF_CRYPTOCURRENCY_IDS: "bitcoin, ethereum",
             CONF_MULTIPLIERS: "1, 32",
             CONF_CURRENCY_NAME: "usd",
             CONF_UNIT_OF_MEASUREMENT: "$",
@@ -178,8 +178,8 @@ async def async_step_user(self, user_input: dict[str, Any] | None = None):
             {
                 vol.Optional(CONF_ID, default=defaults[CONF_ID]): str,
                 vol.Required(
-                    CONF_CRYPTOCURRENCY_NAMES,
-                    default=defaults[CONF_CRYPTOCURRENCY_NAMES],
+                    CONF_CRYPTOCURRENCY_IDS,
+                    default=defaults[CONF_CRYPTOCURRENCY_IDS],
                 ): str,
                 vol.Required(CONF_MULTIPLIERS, default=defaults[CONF_MULTIPLIERS]): str,
                 vol.Required(

custom_components/cryptoinfo/const/const.py

@@ -3,7 +3,7 @@
 DOMAIN = "cryptoinfo"
 
 CONF_ID = "id"
-CONF_CRYPTOCURRENCY_NAMES = "cryptocurrency_names"
+CONF_CRYPTOCURRENCY_IDS = "cryptocurrency_ids"
 CONF_CURRENCY_NAME = "currency_name"
 CONF_MULTIPLIERS = "multipliers"
 CONF_UPDATE_FREQUENCY = "update_frequency"
@@ -12,6 +12,10 @@
 
 SENSOR_PREFIX = "Cryptoinfo "
 ATTR_LAST_UPDATE = "last_update"
+ATTR_CRYPTOCURRENCY_ID = "cryptocurrency_id"
+ATTR_CRYPTOCURRENCY_NAME = "cryptocurrency_name"
+ATTR_CRYPTOCURRENCY_SYMBOL = "cryptocurrency_symbol"
+ATTR_CURRENCY_NAME = "currency_name"
 ATTR_BASE_PRICE = "baseprice"
 ATTR_MULTIPLIER = "multiplier"
 ATTR_24H_VOLUME = "24h_volume"

custom_components/cryptoinfo/manifest.json

@@ -1,7 +1,7 @@
 {
   "domain": "cryptoinfo",
   "name": "Cryptoinfo",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "config_flow": true,
   "iot_class": "cloud_polling",
   "documentation": "https://github.com/heyajohnny/cryptoinfo",

custom_components/cryptoinfo/sensor.py

@@ -28,17 +28,20 @@
     ATTR_BASE_PRICE,
     ATTR_CIRCULATING_SUPPLY,
     ATTR_LAST_UPDATE,
+    ATTR_CRYPTOCURRENCY_ID,
+    ATTR_CRYPTOCURRENCY_NAME,
+    ATTR_CRYPTOCURRENCY_SYMBOL,
+    ATTR_CURRENCY_NAME,
     ATTR_MARKET_CAP,
     ATTR_MULTIPLIER,
     ATTR_TOTAL_SUPPLY,
-    CONF_CRYPTOCURRENCY_NAMES,
+    CONF_CRYPTOCURRENCY_IDS,
     CONF_CURRENCY_NAME,
     CONF_ID,
     CONF_MIN_TIME_BETWEEN_REQUESTS,
     CONF_MULTIPLIERS,
     CONF_UNIT_OF_MEASUREMENT,
     CONF_UPDATE_FREQUENCY,
-    DOMAIN,
     SENSOR_PREFIX,
 )
 
@@ -53,7 +56,7 @@ async def async_setup_entry(
     config = config_entry.data
 
     id_name = config.get(CONF_ID)
-    cryptocurrency_names = config.get(CONF_CRYPTOCURRENCY_NAMES).lower().strip()
+    cryptocurrency_ids = config.get(CONF_CRYPTOCURRENCY_IDS).lower().strip()
     currency_name = config.get(CONF_CURRENCY_NAME).strip()
     unit_of_measurement = config.get(CONF_UNIT_OF_MEASUREMENT).strip()
     multipliers = config.get(CONF_MULTIPLIERS).strip()
@@ -65,7 +68,7 @@ async def async_setup_entry(
     # Create coordinator for centralized data fetching
     coordinator = CryptoDataCoordinator(
         hass,
-        cryptocurrency_names,
+        cryptocurrency_ids,
         currency_name,
         update_frequency,
         min_time_between_requests,
@@ -76,24 +79,24 @@ async def async_setup_entry(
     await coordinator.async_config_entry_first_refresh()
 
     entities = []
-    crypto_list = [crypto.strip() for crypto in cryptocurrency_names.split(",")]
+    crypto_list = [crypto.strip() for crypto in cryptocurrency_ids.split(",")]
     multipliers_list = [multiplier.strip() for multiplier in multipliers.split(",")]
 
     multipliers_length = len(multipliers_list)
     crypto_list_length = len(crypto_list)
 
     if multipliers_length != crypto_list_length:
         _LOGGER.error(
-            f"Length mismatch: multipliers ({multipliers_length}) and cryptocurrency names ({crypto_list_length}) must have the same length"
+            f"Length mismatch: multipliers ({multipliers_length}) and cryptocurrency id's ({crypto_list_length}) must have the same length"
         )
         return False
 
-    for i, cryptocurrency_name in enumerate(crypto_list):
+    for i, cryptocurrency_id in enumerate(crypto_list):
         try:
             entities.append(
                 CryptoinfoSensor(
                     coordinator,
-                    cryptocurrency_name,
+                    cryptocurrency_id,
                     currency_name,
                     unit_of_measurement,
                     multipliers_list[i],
@@ -116,7 +119,7 @@ class CryptoDataCoordinator(DataUpdateCoordinator):
     def __init__(
         self,
         hass: HomeAssistant,
-        cryptocurrency_names: str,
+        cryptocurrency_ids: str,
         currency_name: str,
         update_frequency: timedelta,
         min_time_between_requests: timedelta,
@@ -133,7 +136,7 @@ def __init__(
         )  # Assign current count as instance ID
         CryptoDataCoordinator._instance_count += 1  # Increment the counter
         CryptoDataCoordinator._active_coordinators.add(self.instance_id)
-        self.cryptocurrency_names = cryptocurrency_names
+        self.cryptocurrency_ids = cryptocurrency_ids
         self.currency_name = currency_name
         self.id_name = id_name
         self.min_time_between_requests = min_time_between_requests
@@ -157,12 +160,12 @@ async def _async_update_data(self):
             CryptoDataCoordinator._last_updated_id = self.instance_id
 
             _LOGGER.debug(
-                f"First request, fetching data for sensor: {self.id_name} instance_id: {self.instance_id} cryptocurrency_names: {self.cryptocurrency_names}"
+                f"First request, fetching data for sensor: {self.id_name} instance_id: {self.instance_id} cryptocurrency_ids: {self.cryptocurrency_ids}"
             )
 
             url = (
                 f"{API_ENDPOINT}coins/markets"
-                f"?ids={self.cryptocurrency_names}"
+                f"?ids={self.cryptocurrency_ids}"
                 f"&vs_currency={self.currency_name}"
                 f"&price_change_percentage=1h%2C24h%2C7d%2C30d"
             )
@@ -213,12 +216,12 @@ async def _async_update_data(self):
             return self.data if self.data else None
 
         _LOGGER.debug(
-            f"Fetch data from API endpoint, sensor: {self.id_name} instance_id: {self.instance_id} cryptocurrency_names: {self.cryptocurrency_names}"
+            f"Fetch data from API endpoint, sensor: {self.id_name} instance_id: {self.instance_id} cryptocurrency_ids: {self.cryptocurrency_ids}"
         )
 
         url = (
             f"{API_ENDPOINT}coins/markets"
-            f"?ids={self.cryptocurrency_names}"
+            f"?ids={self.cryptocurrency_ids}"
             f"&vs_currency={self.currency_name}"
             f"&price_change_percentage=1h%2C24h%2C7d%2C30d"
         )
@@ -242,14 +245,14 @@ class CryptoinfoSensor(CoordinatorEntity):
     def __init__(
         self,
         coordinator: CryptoDataCoordinator,
-        cryptocurrency_name: str,
+        cryptocurrency_id: str,
         currency_name: str,
         unit_of_measurement: str,
         multiplier: str,
         id_name: str,
     ):
         super().__init__(coordinator)
-        self.cryptocurrency_name = cryptocurrency_name
+        self.cryptocurrency_id = cryptocurrency_id
         self.currency_name = currency_name
         self._unit_of_measurement = unit_of_measurement
         self.multiplier = multiplier
@@ -258,7 +261,7 @@ def __init__(
             (SENSOR_PREFIX + (id_name + " " if len(id_name) > 0 else ""))
             .lower()
             .replace(" ", "_")
-            + cryptocurrency_name
+            + cryptocurrency_id
             + "_"
             + currency_name
         )
@@ -267,7 +270,7 @@ def __init__(
         self._attr_unique_id = (
             SENSOR_PREFIX
             + (id_name + " " if len(id_name) > 0 else "")
-            + cryptocurrency_name
+            + cryptocurrency_id
             + currency_name
         )
 
@@ -286,9 +289,9 @@ def unit_of_measurement(self):
     @property
     def state(self):
         """Return the state of the sensor."""
-        if self.coordinator.data and self.cryptocurrency_name in self.coordinator.data:
+        if self.coordinator.data and self.cryptocurrency_id in self.coordinator.data:
             return float(
-                self.coordinator.data[self.cryptocurrency_name]["current_price"]
+                self.coordinator.data[self.cryptocurrency_id]["current_price"]
             ) * float(self.multiplier)
         return None
 
@@ -297,10 +300,12 @@ def extra_state_attributes(self):
         """Return the state attributes."""
         if (
             not self.coordinator.data
-            or self.cryptocurrency_name not in self.coordinator.data
+            or self.cryptocurrency_id not in self.coordinator.data
         ):
             return {
                 ATTR_LAST_UPDATE: datetime.today().strftime("%d-%m-%Y %H:%M"),
+                ATTR_CRYPTOCURRENCY_NAME: None,
+                ATTR_CURRENCY_NAME: None,
                 ATTR_BASE_PRICE: None,
                 ATTR_MULTIPLIER: None,
                 ATTR_24H_VOLUME: None,
@@ -313,9 +318,13 @@ def extra_state_attributes(self):
                 ATTR_TOTAL_SUPPLY: None,
             }
 
-        data = self.coordinator.data[self.cryptocurrency_name]
+        data = self.coordinator.data[self.cryptocurrency_id]
         return {
             ATTR_LAST_UPDATE: datetime.today().strftime("%d-%m-%Y %H:%M"),
+            ATTR_CRYPTOCURRENCY_ID: self.cryptocurrency_id,
+            ATTR_CRYPTOCURRENCY_NAME: data["name"],
+            ATTR_CRYPTOCURRENCY_SYMBOL: data["symbol"],
+            ATTR_CURRENCY_NAME: self.currency_name,
             ATTR_BASE_PRICE: data["current_price"],
             ATTR_MULTIPLIER: self.multiplier,
             ATTR_24H_VOLUME: data["total_volume"],