otau_notify.h File Reference

OTAU Notify Interface.

Copyright (c) 2018 Microchip Technology Inc. and its subsidiaries.

#include "otau.h"
#include "sysTimer.h"

Data Structures
struct	otauClientDiscoveryReq_t
struct	otauClientIdentifyRequest_t
struct	otauClientInfoIndication_t
struct	otauClientInfoRequest_t
struct	otauClientNotifyIndication_t
struct	otauClientResetRequest_t

Macros
#define	CLIENT_NOTIFY_INTERVAL_SEC   (10)
#define	CLIENT_NOTIFY_JITTER_PERCENT   (0)
#define	CLIENT_NOTIFY_RETRY_COUNT   (3)
#define	LED_TOGGLE_COUNT   (20)
#define	LED_TOGGLE_INTERVAL_MILLISEC   (100)
#define	MIN_CLIENT_NOTIFY_INTERVAL_SEC   (5)
#define	SERVER_DISCOVERY_INTERVAL_SEC   (10)

Enumerations
enum	otauNotifyMsgCode_t {   OTA_CLIENT_DISCOVERY = 0,   OTA_CLIENT_NOTIFY,   OTA_CLIENT_INFO_REQ,   OTA_CLIENT_INFO,   OTA_IDENTIFY_REQ,   OTA_RESET_REQ,   OTA_ERROR_MSG = 0xF0 }

Functions
void	otauHandleNotifyMsg (otau_domain_msg_t *otau_domain_msg)
void	otauNotifyInit (void)
void	otauNotifyRcvdFrame (addr_mode_t addr_mode, uint8_t *src_addr, uint16_t length, uint8_t *payload)
void	otauNotifySentFrame (uint8_t messageId, addr_mode_t addr_mode, uint8_t *addr, uint8_t status)
void	otauNotifyTimerHandler (struct SYS_Timer_t *timer)

#define CLIENT_NOTIFY_INTERVAL_SEC   (10)

#define CLIENT_NOTIFY_JITTER_PERCENT   (0)

#define CLIENT_NOTIFY_RETRY_COUNT   (3)

#define LED_TOGGLE_COUNT   (20)

Referenced by otauNotifyRcvdFrame().

#define LED_TOGGLE_INTERVAL_MILLISEC   (100)

Referenced by otauNotifyRcvdFrame().

#define MIN_CLIENT_NOTIFY_INTERVAL_SEC   (5)

Referenced by otauClientStartTimer().

#define SERVER_DISCOVERY_INTERVAL_SEC   (10)

enum otauNotifyMsgCode_t

Enumerator
OTA_CLIENT_DISCOVERY
OTA_CLIENT_NOTIFY
OTA_CLIENT_INFO_REQ
OTA_CLIENT_INFO
OTA_IDENTIFY_REQ
OTA_RESET_REQ
OTA_ERROR_MSG

void otauHandleNotifyMsg

(

otau_domain_msg_t *

otau_domain_msg

)

Referenced by otauHandleMsg().

void otauNotifyInit

(

void

)

References CLIENT_NOTIFY_STATE, clientNotifyRetryRunningCount, NOTIFY_IDLE, notifyState, notifyTimerState, and otauClientNotifyRetryCount.

Referenced by otauInit().

void otauNotifyRcvdFrame	(	addr_mode_t	addr_mode,
		uint8_t *	src_addr,
		uint16_t	length,
		uint8_t *	payload
	)

References CLIENT_IDENTIFY_STATE, DOMAIN_OTAU_NOTIFY, otauClientDiscoveryReq_t::interval, otauClientDiscoveryReq_t::jitter_percent, LED_TOGGLE_COUNT, LED_TOGGLE_INTERVAL_MILLISEC, NOTIFY_CLIENT_INFO_STATE, notifyState, notifyTimerState, OTA_CLIENT_DISCOVERY, OTA_CLIENT_INFO_REQ, OTA_IDENTIFY_REQ, OTA_RESET_REQ, otauClientNotifyInterval, otauClientNotifyJitterPercent, otauClientNotifyRetryCount, otauClientStartTimer(), otauDataSend(), otauLedToggleCount, otauNotifyConfirmWait, otauResetDevice(), otauSetServerDetails(), otauTimerStart(), otauClientDiscoveryReq_t::retry_count, and TIMER_MODE_PERIODIC.

Referenced by otauRcvdFrame().

void otauNotifySentFrame	(	uint8_t	messageId,
		addr_mode_t	addr_mode,
		uint8_t *	addr,
		uint8_t	status
	)

References clientNotifyRetryRunningCount, NOTIFY_CLIENT_NOTIFY_STATE, NOTIFY_IDLE, notifyState, OTAU_SUCCESS, otauClientNotifyRetryCount, otauClientSendNotify(), otauClientStartTimer(), and otauNotifyConfirmWait.

Referenced by otauDataConf(), and otauDataSend().

void otauNotifyTimerHandler

(

struct SYS_Timer_t *

timer

)

References CLIENT_IDENTIFY_STATE, CLIENT_NOTIFY_STATE, clientNotifyRetryRunningCount, notifyTimerState, OTAU_LED_TOGGLE, otauClientNotifyRetryCount, otauClientSendNotify(), otauClientStartTimer(), otauLed(), otauLedToggleCount, and otauNotifyConfirmWait.

Referenced by otauTimerStart().