hamqtt_device.h

Go to the documentation of this file.

/*
 * Copyright 2025 Ethan Barnes
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

 
#pragma once
 
#include "common.h"
#include "hamqtt_component.h"

typedef struct {
    char *mqtt_config_topic_prefix; 
    char *mqtt_uri;                 
    char *mqtt_username;            
    char *mqtt_password;            
    char *manufacturer;             
    char *model;                    
    char *serial_number;            
    char *unique_id;                
    char *sw_version;               
    char *hw_version;               
    char *origin_url;               
    char *name;                     
} HAMQTT_Device_Config;

HAMQTT_Device_Config hamqtt_device_config_default(void);

typedef struct HAMQTT_Device HAMQTT_Device;

HAMQTT_Device *hamqtt_device_create(HAMQTT_Device_Config *config);

void hamqtt_device_destroy(HAMQTT_Device *device);

esp_err_t hamqtt_device_add_component(HAMQTT_Device *device, HAMQTT_Component *component);

esp_err_t hamqtt_device_connect(HAMQTT_Device *device);

esp_err_t hamqtt_device_publish_availability(const HAMQTT_Device *device, bool availability);

void hamqtt_device_loop(const HAMQTT_Device *device);

const HAMQTT_Device_Config *hamqtt_device_get_config(const HAMQTT_Device *device);