health_client.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef HEALTH_CLIENT_H__
#define HEALTH_CLIENT_H__

#include <stdbool.h>
#include <stdint.h>

#include "access.h"
#include "device_state_manager.h"
#include "health_common.h"

#ifndef HEALTH_CLIENT_ACKED_TRANSACTION_TIMEOUT
#define HEALTH_CLIENT_ACKED_TRANSACTION_TIMEOUT (SEC_TO_US(60))
#endif

typedef struct __health_client_t health_client_t;

typedef enum
{
 HEALTH_CLIENT_EVT_TYPE_CURRENT_STATUS_RECEIVED, 
 HEALTH_CLIENT_EVT_TYPE_FAULT_STATUS_RECEIVED, 
 HEALTH_CLIENT_EVT_TYPE_PERIOD_STATUS_RECEIVED, 
 HEALTH_CLIENT_EVT_TYPE_ATTENTION_STATUS_RECEIVED, 
 HEALTH_CLIENT_EVT_TYPE_TIMEOUT, 
 HEALTH_CLIENT_EVT_TYPE_CANCELLED 
} health_client_evt_type_t;

typedef struct
{
 uint8_t test_id; 
 uint16_t company_id; 
 uint8_t fault_array_length; 
 const uint8_t * p_fault_array; 
 const access_message_rx_meta_t * p_meta_data; 
} health_client_evt_fault_status_t;

typedef struct
{
 uint8_t fast_period_divisor;
} health_client_evt_period_status_t;

typedef struct
{
 uint8_t attention; 
} health_client_evt_attention_status_t;

typedef struct
{
 health_client_evt_type_t type; 
 const access_message_rx_meta_t * p_meta_data; 
 union {
 health_client_evt_fault_status_t fault_status; 
 health_client_evt_period_status_t period_status; 
 health_client_evt_attention_status_t attention_status; 
 } data;
} health_client_evt_t;

typedef void (*health_client_evt_cb_t)(const health_client_t * p_client, const health_client_evt_t * p_event);

struct __health_client_t
{
 access_model_handle_t model_handle; 
 health_client_evt_cb_t event_handler; 
 bool waiting_for_reply; 
 uint8_t * p_buffer; 
};

uint32_t health_client_fault_get(health_client_t * p_client, uint16_t company_id);

uint32_t health_client_fault_clear(health_client_t * p_client, uint16_t company_id, bool acked);

uint32_t health_client_fault_test(health_client_t * p_client, uint16_t company_id, uint8_t test_id, bool acked);

uint32_t health_client_period_get(health_client_t * p_client);

uint32_t health_client_period_set(health_client_t * p_client, uint8_t fast_period_divisor, bool acked);

uint32_t health_client_attention_get(health_client_t * p_client);

uint32_t health_client_attention_set(health_client_t * p_client, uint8_t attention_timer, bool acked);

uint32_t health_client_init(health_client_t * p_client, uint16_t element_index, health_client_evt_cb_t evt_handler);

void health_client_pending_msg_cancel(health_client_t * p_client);

#endif