rdm_util.h

Go to the documentation of this file.

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * rdm_util.h
 * Copyright (C) 2015 Simon Newton
 */

#ifndef FIRMWARE_SRC_RDM_UTIL_H_
#define FIRMWARE_SRC_RDM_UTIL_H_

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

#include "rdm.h"
#include "rdm_responder.h"

#ifdef __cplusplus
extern "C" {
#endif

static inline int RDMUtil_UIDCompare(const uint8_t *uid1, const uint8_t *uid2) {
  return memcmp(uid1, uid2, UID_LENGTH);
}

bool RDMUtil_RequiresAction(const uint8_t our_uid[UID_LENGTH],
                            const uint8_t uid[UID_LENGTH]);

/*
 * @brief Check if a UID is unicast.
 * @param uid The destination UID to check.
 * @returns true if the UIDs is unicast, false otherwise.
 *
 * This can be used to determine if we need to respond to a request. Unicast
 * UIDs are ones that do not end in 0xffffffff.
 */
bool RDMUtil_IsUnicast(const uint8_t uid[UID_LENGTH]);

bool RDMUtil_VerifyChecksum(const uint8_t *frame, unsigned int size);

int RDMUtil_AppendChecksum(uint8_t *frame);

unsigned int RDMUtil_StringCopy(char *dst, unsigned int dest_size,
                                const char *src, unsigned int max_size);

unsigned int RDMUtil_SafeStringLength(const char *str, unsigned int max_size);

void RDMUtil_UpdateSensor(SensorData *sensor, uint8_t recorded_value_support,
                          int16_t new_value);

#ifdef __cplusplus
}
#endif

#endif  // FIRMWARE_SRC_RDM_UTIL_H_