Setting up Growstuff plantings as Home Assistant Sensors [WIP]

[CloCkWeRX]

Home Assistant is a home automation platform that supports a range of sensors and triggers.

My use case is to display the progress of my plantings in the home assistant dashboard.

Home assistant supports a generic rest integration:
https://www.home-assistant.io/integrations/rest/

  - platform: rest
    name: Growstuff Plantings
    resource: https://www.growstuff.org/members/clockwerx/plantings.json
    value_template: '{{ value_json.crop_name }}'
    json_attributes:
      - crop_name
      - finish_predicted_at
      - percentage_grown
      - thumbnail_url
      - active
      - slug
  - platform: template
    sensors:
       crop_percentage:
        friendly_name_template: '{{ states.sensor.growstuff_plantings.attributes["crop_name"] }} Percentage'
        value_template: '{{ states.sensor.growstuff_plantings.attributes["percentage_grown"] }}'
        entity_picture_template: '{{ states.sensor.growstuff_plantings.attributes["thumbnail_url"] }}'
        attribute_templates:
          finish_predicted_at: '{{ states.sensor.growstuff_plantings.attributes["finish_predicted_at"] }}'
          slug: 'https://www.growstuff.org/plantings/{{ states.sensor.growstuff_plantings.attributes["slug"] }}'

Note: I tried using the API, but got errors

curl -X GET "https://www.growstuff.org/api/v1/plantings?filter%5Bowner%5D=clockwerx" -H "accept: application/vnd.api+json"

This will get your first crop and show the attributes:

Remaining tasks

• Multiple crops without repeating sensors - rewrite as custom component?

[Br3nda]

i made a full custom components:

"""HA component to import plantings status from growstuff.org."""
import logging
import requests

from homeassistant.helpers.entity import Entity

_ICON = 'mdi:leaf'
_API_URL = "https://www.growstuff.org/api/v1"
_LOGGER = logging.getLogger('growstuff')


def setup_platform(hass, config, add_devices, discovery_info=None):
    """Set up all plantings."""
    member_url = '{api_url}/members?filter[login-name]={member}'.format(
        api_url=_API_URL,
        member=config.get('member'))

    member = requests.get(member_url).json().get('data')[0]
    plantings_url = "{api_url}/members/{member_id}/plantings{filters}".format(
        api_url=_API_URL,
        member_id=member.get('id'),
        filters="?filter[finished]=false")

    add_plantings(plantings_url, add_devices)


def add_plantings(plantings_url, add_devices):
    """Add plantings until we added them all."""
    response = requests.get(plantings_url).json()
    devices = []
    for planting in (response.get('data')):
        devices.append(GrowstuffPlantingSensor(planting))
    add_devices(devices)
    links = response.get('links')
    if links.get('next'):
        add_plantings(links.get('next'), add_devices)


class GrowstuffPlantingSensor(Entity):
    """Grow stuff."""

    def __init__(self, planting):
        """Initialize the sensor."""
        self.planting_id = planting.get('id')
        self._links = planting.get('links')
        self._attributes = planting.get('attributes')
        self._relationships = planting.get('relationships')

    # def update(self):
    #     """Fetch new state data for the sensor.

    #     This is the only method that should fetch new data for Home Assistant.
    #     """
    #     plantings_url = "{api_url}/planting/{planting_id}".format(
    #         api_url=_API_URL,
    #         planting_id=self.planting_id)
    #     response = requests.get(plantings_url).json()
    #     planting_data = response.get('data')
    #     self._attributes = planting_data.get('attributes')

    @property
    def unique_id(self):
        """Return the ID of the sensor."""
        return self._attributes.get('slug')

    @property
    def name(self):
        """Return the name of the sensor."""
        return 'growstuff_{name}'.format(name=self._attributes.get('slug'))

    @property
    def friendly_name(self):
        """The crop is used as the friendly name."""
        return self._attributes.get('crop-name')

    @property
    def state(self):
        """Return the state of the sensor."""
        percent = self._attributes.get('percentage-grown')
        if isinstance(percent, float):
            return round(percent, 2)

    @property
    def device_state_attributes(self):
        """Return the state attributes."""
        return self._attributes

    def _url(self):
        return self._links.get('self')

    @property
    def entity_picture(self):
        """Icon to use in the frontend, if any."""
        return self._attributes.get('thumbnail')

    @property
    def unit_of_measurement(self):
        """Return the unit this state is expressed in."""
        return '%'

    def update(self):
        """Get the latest data from Growstuff and update the states."""
        response = requests.get(self._url())
        self.__init__(response.json().get('data'))

[CloCkWeRX]

Oh, nice!

…

On Tue, Apr 13, 2021 at 6:56 AM Brenda Wallace ***@***.***> wrote: i made a full custom components: """HA component to import plantings status from growstuff.org."""import loggingimport requests from homeassistant.helpers.entity import Entity _ICON = 'mdi:leaf'_API_URL = "https://www.growstuff.org/api/v1"_LOGGER = logging.getLogger('growstuff') def setup_platform(hass, config, add_devices, discovery_info=None): """Set up all plantings.""" member_url = '{api_url}/members?filter[login-name]={member}'.format( api_url=_API_URL, member=config.get('member')) member = requests.get(member_url).json().get('data')[0] plantings_url = "{api_url}/members/{member_id}/plantings{filters}".format( api_url=_API_URL, member_id=member.get('id'), filters="?filter[finished]=false") add_plantings(plantings_url, add_devices) def add_plantings(plantings_url, add_devices): """Add plantings until we added them all.""" response = requests.get(plantings_url).json() devices = [] for planting in (response.get('data')): devices.append(GrowstuffPlantingSensor(planting)) add_devices(devices) links = response.get('links') if links.get('next'): add_plantings(links.get('next'), add_devices) class GrowstuffPlantingSensor(Entity): """Grow stuff.""" def __init__(self, planting): """Initialize the sensor.""" self.planting_id = planting.get('id') self._links = planting.get('links') self._attributes = planting.get('attributes') self._relationships = planting.get('relationships') # def update(self): # """Fetch new state data for the sensor. # This is the only method that should fetch new data for Home Assistant. # """ # plantings_url = "{api_url}/planting/{planting_id}".format( # api_url=_API_URL, # planting_id=self.planting_id) # response = requests.get(plantings_url).json() # planting_data = response.get('data') # self._attributes = planting_data.get('attributes') @Property def unique_id(self): """Return the ID of the sensor.""" return self._attributes.get('slug') @Property def name(self): """Return the name of the sensor.""" return 'growstuff_{name}'.format(name=self._attributes.get('slug')) @Property def friendly_name(self): """The crop is used as the friendly name.""" return self._attributes.get('crop-name') @Property def state(self): """Return the state of the sensor.""" percent = self._attributes.get('percentage-grown') if isinstance(percent, float): return round(percent, 2) @Property def device_state_attributes(self): """Return the state attributes.""" return self._attributes def _url(self): return self._links.get('self') @Property def entity_picture(self): """Icon to use in the frontend, if any.""" return self._attributes.get('thumbnail') @Property def unit_of_measurement(self): """Return the unit this state is expressed in.""" return '%' def update(self): """Get the latest data from Growstuff and update the states.""" response = requests.get(self._url()) self.__init__(response.json().get('data')) — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#2746 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACZJN5TVZPR37ROOU44TXLTINQQHANCNFSM4WQJVVYA> .

[CloCkWeRX]

Turned into a repo: https://github.com/Growstuff/homeassistant-growstuff

[Br3nda]

Would be neat to link it to irrigation somehow

[CloCkWeRX]

One of my main issues is scheduling. Going to work a bit on just making the above custom component easy to setup (config flow).

Roadmap for this; if I don't get distracted by shiny things:

• Config flow
• Look at what write capabilities we could have, to push "Watered" events in
• Long term statistics if applicable?

[CloCkWeRX]

@Olen this might be of interest to you. Growstuff is more crop focused, but there is an (unmaintained) crop recipe API we work with.
Similar goals to openplantbook.io