Topic for subscription. And request and response format.

[sduraiengineer]

Topic and payload format

Let we use all small letters and words sepearted by "_" for all topic and payload.
And since it is request and response model, let we use QoS 1.

For mqtt5 version:

Topic : openmeteo/v1/mqtt5/requests/weather_api
Properities:

• response topic: /* Topic to respond */
• correlation data: /* data to uniquely identify the response */

Payload :

Same as REST api of openmeteo. Reference: https://open-meteo.com/en/docs#api_documentation. Below is example of payload. Note: latitude and longitude are required as per open-meteo.

{
  "data": {
    "latitude": 11,
    "longitude": 11,
    "cell_selection": "land",
    "forecast_days": 3,
    "past_days": 0,
    "daily": [
      "temperature_2m_min",
      "temperature_2m_max",
      "rain_sum",
      "showers_sum",
      "snowfall_sum",
      "weather_code",
      "wind_speed_10m_max",
      "wind_direction_10m_dominant",
      "wind_gusts_10m_max",
      "sunrise",
      "sunset",
      "daylight_duration",
      "sunshine_duration"
    ]
  }
}

Response:
forwarded the response from openmeta to the client along with correlation data in the requested topic.

For mqtt3 version:

Topic : openmeteo/v1/mqtt3/requests/weather_api
Payload :
Same as REST api of openmeteo. Reference: https://open-meteo.com/en/docs#api_documentation. Below is example of payload. Note: latitude and longitude are required as per open-meteo. In addtion, the payload should contain two additonal fields - response topic and correlation data.

{
 "response_topic" : "example/response"
"correlation_data": 12 
  "data": {
    "latitude": 11,
    "longitude": 11,
    "cell_selection": "land",
    "forecast_days": 3,
    "past_days": 0,
    "daily": [
      "temperature_2m_min",
      "temperature_2m_max",
      "rain_sum",
      "showers_sum",
      "snowfall_sum",
      "weather_code",
      "wind_speed_10m_max",
      "wind_direction_10m_dominant",
      "wind_gusts_10m_max",
      "sunrise",
      "sunset",
      "daylight_duration",
      "sunshine_duration"
    ]
  }
}

Response:
forwarded the response from openmeta to the requested client with topic as given in the payload + / + correlation data. For the above example, the topic will be example/response/12

[sduraiengineer]

@cybcon Please let me know your comments.

[cybcon]

Dear @sduraiengineer ,

thank you for the suggestions.

In the json payload, I checked that all attributes are in lower case and follows the snake_case format.

Regarding "QoS". this is mre a fire and forget scenario, because there is no MQTT based request. The mode and configuraiton is part of the container/script configuration. there is no subscription from the tool itself. So I think QoS of 0 is still good.

Regarding the MQTT topics. The topic can be configured completely freely by the end user via the environment variables. And I'm not sure if we should enforce a lower case here because it's not expected. The currently configured default topic should be viewed as an example and ensures that the script runs without errors even without user configuration. I also do not consider it useful to differentiate between MQTT versions within the topic.

Yes, latitude and longitude is needed from Open Meteo, so it needs to be configured via environment variables. The basic rest api call payload is part of the configuration file the reflects the "current" weather and the weather forecast for "tomorrow". All what is in that configuration file is the generic information that should be send with every call. Enriched with the users configuration.

Regarding response topic and correlation data. This is needed for a request/response scenario that we don't have in this tool.
the functionality of this tool is:

• Script (Container) starts
• do the API call with the given configuration
• format the Open Meteo API results for "current" or "tomorrow" mode
• send the formatted JSON to the configured MQTT endpoint
• Script (Container) stops

Updates in the topic will be done by executing the script (or the container - e.g. as a kubernetes recurring job or via crontab).

[cybcon]

Creating PR #8

[cybcon]

lower case fix implemented in release 1.0.2