CC_Supervision.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2018 Silicon Laboratories Inc. <https://www.silabs.com/>
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */

 
#ifndef _COMMAND_CLASS_SUPERVISION_H_
#define _COMMAND_CLASS_SUPERVISION_H_
 
#include <stdint.h>
#include <ZW_classcmd.h>
#include "zaf_transport_tx.h"
#include "ZAF_CC_Invoker.h"

 
#define CC_SUPERVISION_EXTRACT_SESSION_ID(properties)  (properties & 0x3F) 
#define CC_SUPERVISION_ADD_SESSION_ID(properties)  (properties & 0x3F)     
#define CC_SUPERVISION_EXTRACT_MORE_STATUS_UPDATE(status) (status >> 7)    
#define CC_SUPERVISION_ADD_MORE_STATUS_UPDATE(status)  (status << 7)       
#define CC_SUPERVISION_EXTRACT_STATUS_UPDATE(status) (status >> 7)    
#define CC_SUPERVISION_ADD_STATUS_UPDATE(status)  (status << 7)       

#define CC_SUPERVISION_EVENT_SUCCESS 1
#define CC_SUPERVISION_EVENT_FAIL    2
#define CC_SUPERVISION_EVENT_WORKING 3

typedef enum {
  CC_SUPERVISION_MORE_STATUS_UPDATES_THIS_IS_LAST,    
  CC_SUPERVISION_MORE_STATUS_UPDATES_REPORTS_TO_FOLLOW
} cc_supervision_more_status_updates_t;

typedef enum _SUPERVISION_STATUS_{
  CC_SUPERVISION_STATUS_NOT_SUPPORTED,
  CC_SUPERVISION_STATUS_WORKING,      
  CC_SUPERVISION_STATUS_FAIL,         
  CC_SUPERVISION_STATUS_CANCEL,       
  CC_SUPERVISION_STATUS_NOT_FOUND,    
  CC_SUPERVISION_STATUS_SUCCESS = 0xFF
} cc_supervision_status_t;

typedef struct {
  uint8_t cmdClass; 
  uint8_t cmd; 
  uint8_t properties1; 
  cc_supervision_status_t status; 
  uint8_t duration; 
  RECEIVE_OPTIONS_TYPE_EX * rxOpt; 
}
SUPERVISION_GET_RECEIVED_HANDLER_ARGS;

typedef struct _cc_supervision_report_event {
  zaf_tx_options_t tx_options;  
  uint8_t session_id;             
  bool status_update;             
  uint8_t duration;               
} cc_supervision_report_event;

bool
CmdClassSupervisionReportSend(
  zaf_tx_options_t* tx_options,
  uint8_t properties,
  cc_supervision_status_t status,
  uint8_t duration);

void CommandClassSupervisionGetAdd(ZW_SUPERVISION_GET_FRAME* pPayload);

void
CommandClassSupervisionGetWrite(ZW_SUPERVISION_GET_FRAME* pbuf);

void CommandClassSupervisionGetSetPayloadLength(ZW_SUPERVISION_GET_FRAME* pbuf, uint8_t payLoadlen);

uint8_t CommandClassSupervisionGetGetPayloadLength(ZW_SUPERVISION_GET_FRAME* pbuf);

 
#endif /*_COMMAND_CLASS_SUPERVISION_H_*/