lwpa_cid.h

/******************************************************************************
 * Copyright 2018 ETC Inc.
 *
 * 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.
 *******************************************************************************
 * This file is a part of lwpa. For more information, go to:
 * https://github.com/ETCLabs/lwpa
 ******************************************************************************/
 
/* lwpa_cid.h: A type and helper functions for the Component IDentifier (CID)
 * used in the ACN family of protocols. */
#ifndef _LWPA_CID_H_
#define _LWPA_CID_H_
 
#include <string.h>
#include "lwpa_int.h"
#include "lwpa_bool.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define CID_BYTES 16u
 
typedef struct LwpaCid
{
  uint8_t data[CID_BYTES];
} LwpaCid;
 
#define cidcmp(cid1ptr, cid2ptr) memcmp((cid1ptr)->data, (cid2ptr)->data, CID_BYTES)
 
extern const LwpaCid NULL_CID;
 
#define cid_isnull(cidptr) (memcmp((cidptr)->data, NULL_CID.data, CID_BYTES) == 0)
 
#define CID_STRING_BYTES 37
 
void cid_to_string(char *buf, const LwpaCid *cid);
bool string_to_cid(LwpaCid *cid, const char *buf, size_t buflen);
 
/************************ CID Generation Functions ***************************/
 
void generate_cid(LwpaCid *cid, const char *devstr, const uint8_t *macaddr, uint32_t cidnum);
void generate_rdm_cid(LwpaCid *cid, const uint8_t *rdmuid);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _LWPA_CID_H_ */