mirror of
https://github.com/stargieg/bacnet-stack
synced 2025-10-26 23:35:52 +08:00
282 lines
8.7 KiB
C
282 lines
8.7 KiB
C
/**************************************************************************
|
|
*
|
|
* Copyright (C) 2011 Steve Karg <skarg@users.sourceforge.net>
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining
|
|
* a copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, sublicense, and/or sell copies of the Software, and to
|
|
* permit persons to whom the Software is furnished to do so, subject to
|
|
* the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included
|
|
* in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
*********************************************************************/
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <stdlib.h>
|
|
#include <string.h>
|
|
#include "bacdef.h"
|
|
#include "bacdcode.h"
|
|
#include "bacstr.h"
|
|
#include "nvmdata.h"
|
|
#include "device.h"
|
|
#include "bname.h"
|
|
|
|
/*************************************************************************
|
|
* DESCRIPTION: Test the BACnet CharacterString for validity
|
|
* RETURN: true if valid
|
|
* NOTES: none
|
|
**************************************************************************/
|
|
static bool bacnet_name_isvalid(uint8_t encoding,
|
|
uint8_t length,
|
|
char *str)
|
|
{
|
|
bool valid = false;
|
|
|
|
if ((encoding < MAX_CHARACTER_STRING_ENCODING) &&
|
|
(length <= NVM_NAME_SIZE)) {
|
|
if (encoding == CHARACTER_UTF8) {
|
|
valid = utf8_isvalid(str, length);
|
|
} else {
|
|
valid = true;
|
|
}
|
|
}
|
|
|
|
return valid;
|
|
}
|
|
|
|
/*************************************************************************
|
|
* DESCRIPTION: Copy the name from non-volatile memory at offset
|
|
* RETURN: number of bytes read, or -1 on error
|
|
* NOTES: none
|
|
**************************************************************************/
|
|
int bacnet_name_copy(
|
|
uint16_t offset,
|
|
uint8_t *dest,
|
|
uint8_t dest_len)
|
|
{
|
|
uint8_t encoding = 0;
|
|
uint8_t length = 0;
|
|
char name[NVM_NAME_SIZE + 1] = "";
|
|
unsigned i = 0;
|
|
int bytes_read = -1;
|
|
|
|
nvm_read(NVM_NAME_ENCODING(offset), &encoding, 1);
|
|
nvm_read(NVM_NAME_LENGTH(offset), &length, 1);
|
|
nvm_read(NVM_NAME_STRING(offset),
|
|
(uint8_t *) & name, NVM_NAME_SIZE);
|
|
if (bacnet_name_isvalid(encoding, length, name)) {
|
|
if (dest_len > NVM_NAME_SIZE) {
|
|
dest_len = NVM_NAME_SIZE;
|
|
}
|
|
bytes_read = dest_len;
|
|
for (i = 0; i < dest_len; i++) {
|
|
if (i < length) {
|
|
dest[i] = name[i];
|
|
} else {
|
|
dest[i] = 0;
|
|
}
|
|
}
|
|
} else {
|
|
for (i = 0; i < dest_len; i++) {
|
|
dest[i] = 0;
|
|
}
|
|
}
|
|
|
|
return bytes_read;
|
|
}
|
|
|
|
/*************************************************************************
|
|
* DESCRIPTION: Encode the name in a buffer in the sequence stored in EEPROM.
|
|
* RETURN: number of bytes in buffer, or 0 if too big to fit.
|
|
* NOTES: none
|
|
**************************************************************************/
|
|
uint8_t bacnet_name_encode(
|
|
uint8_t *buffer,
|
|
uint8_t buffer_len,
|
|
uint8_t encoding,
|
|
char *str,
|
|
uint8_t str_len)
|
|
{
|
|
unsigned len = 0;
|
|
unsigned i = 0;
|
|
|
|
if (str_len < (255-2)) {
|
|
len = 1 + 1 + str_len;
|
|
if (len <= buffer_len) {
|
|
buffer[NVM_NAME_LENGTH(0)] = str_len;
|
|
buffer[NVM_NAME_ENCODING(0)] = encoding;
|
|
for (i = 0; i < str_len; i++) {
|
|
buffer[NVM_NAME_STRING(0)+i] = str[i];
|
|
}
|
|
} else {
|
|
len = 0;
|
|
}
|
|
}
|
|
|
|
return len;
|
|
}
|
|
|
|
/*************************************************************************
|
|
* DESCRIPTION: Store the name to non-volatile memory at offset
|
|
* RETURN: true if name is a valid set of characters
|
|
* NOTES: none
|
|
**************************************************************************/
|
|
bool bacnet_name_save(
|
|
uint16_t offset,
|
|
uint8_t encoding,
|
|
char *str,
|
|
uint8_t str_len)
|
|
{
|
|
uint8_t buffer[NVM_NAME_SIZE] = { 0 };
|
|
uint8_t length = 0;
|
|
|
|
if (bacnet_name_isvalid(encoding, str_len, str)) {
|
|
length = bacnet_name_encode(
|
|
buffer,
|
|
sizeof(buffer),
|
|
encoding,
|
|
str,
|
|
str_len);
|
|
if (length) {
|
|
nvm_write(
|
|
offset,
|
|
&buffer[0],length);
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
bool bacnet_name_set(uint16_t offset,
|
|
BACNET_CHARACTER_STRING * char_string)
|
|
{
|
|
uint8_t encoding = 0;
|
|
uint8_t length = 0;
|
|
char *str = NULL;
|
|
|
|
length = characterstring_length(char_string);
|
|
encoding = characterstring_encoding(char_string);
|
|
str = characterstring_value(char_string);
|
|
return bacnet_name_save(offset, encoding, str, length);
|
|
}
|
|
|
|
bool bacnet_name_write_unique(uint16_t offset,
|
|
int object_type,
|
|
uint32_t object_instance,
|
|
BACNET_CHARACTER_STRING * char_string,
|
|
BACNET_ERROR_CLASS * error_class,
|
|
BACNET_ERROR_CODE * error_code)
|
|
{
|
|
bool status = false;
|
|
size_t length = 0;
|
|
uint8_t encoding = 0;
|
|
int duplicate_type = 0;
|
|
uint32_t duplicate_instance = 0;
|
|
|
|
length = characterstring_length(char_string);
|
|
if (length < 1) {
|
|
*error_class = ERROR_CLASS_PROPERTY;
|
|
*error_code = ERROR_CODE_VALUE_OUT_OF_RANGE;
|
|
} else if (length <= NVM_NAME_SIZE) {
|
|
encoding = characterstring_encoding(char_string);
|
|
if (encoding < MAX_CHARACTER_STRING_ENCODING) {
|
|
if (Device_Valid_Object_Name(char_string, &duplicate_type,
|
|
&duplicate_instance)) {
|
|
if ((duplicate_type == object_type) &&
|
|
(duplicate_instance == object_instance)) {
|
|
/* writing same name to same object */
|
|
status = true;
|
|
} else {
|
|
*error_class = ERROR_CLASS_PROPERTY;
|
|
*error_code = ERROR_CODE_DUPLICATE_NAME;
|
|
}
|
|
} else {
|
|
status = bacnet_name_set(offset, char_string);
|
|
if (status) {
|
|
Device_Inc_Database_Revision();
|
|
} else {
|
|
*error_class = ERROR_CLASS_PROPERTY;
|
|
*error_code = ERROR_CODE_VALUE_OUT_OF_RANGE;
|
|
}
|
|
}
|
|
} else {
|
|
*error_class = ERROR_CLASS_PROPERTY;
|
|
*error_code = ERROR_CODE_CHARACTER_SET_NOT_SUPPORTED;
|
|
}
|
|
} else {
|
|
*error_class = ERROR_CLASS_PROPERTY;
|
|
*error_code = ERROR_CODE_NO_SPACE_TO_WRITE_PROPERTY;
|
|
}
|
|
|
|
return status;
|
|
}
|
|
|
|
/* no required minumum length or duplicate checking */
|
|
bool bacnet_name_write(uint16_t offset,
|
|
BACNET_CHARACTER_STRING * char_string,
|
|
BACNET_ERROR_CLASS * error_class,
|
|
BACNET_ERROR_CODE * error_code)
|
|
{
|
|
bool status = false;
|
|
size_t length = 0;
|
|
uint8_t encoding = 0;
|
|
|
|
length = characterstring_length(char_string);
|
|
if (length <= NVM_NAME_SIZE) {
|
|
encoding = characterstring_encoding(char_string);
|
|
if (encoding < MAX_CHARACTER_STRING_ENCODING) {
|
|
status = bacnet_name_set(offset, char_string);
|
|
if (!status) {
|
|
*error_class = ERROR_CLASS_PROPERTY;
|
|
*error_code = ERROR_CODE_VALUE_OUT_OF_RANGE;
|
|
}
|
|
} else {
|
|
*error_class = ERROR_CLASS_PROPERTY;
|
|
*error_code = ERROR_CODE_CHARACTER_SET_NOT_SUPPORTED;
|
|
}
|
|
} else {
|
|
*error_class = ERROR_CLASS_PROPERTY;
|
|
*error_code = ERROR_CODE_NO_SPACE_TO_WRITE_PROPERTY;
|
|
}
|
|
|
|
return status;
|
|
}
|
|
|
|
void bacnet_name_init(uint16_t offset,
|
|
char *default_string)
|
|
{
|
|
(void) bacnet_name_save(offset, CHARACTER_UTF8, default_string,
|
|
strlen(default_string));
|
|
}
|
|
|
|
void bacnet_name(uint16_t offset,
|
|
BACNET_CHARACTER_STRING * char_string,
|
|
char *default_string)
|
|
{
|
|
uint8_t encoding = 0;
|
|
uint8_t length = 0;
|
|
char name[NVM_NAME_SIZE + 1] = "";
|
|
|
|
nvm_read(NVM_NAME_ENCODING(offset), &encoding, 1);
|
|
nvm_read(NVM_NAME_LENGTH(offset), &length, 1);
|
|
nvm_read(NVM_NAME_STRING(offset), (uint8_t *) & name[0], NVM_NAME_SIZE);
|
|
if (bacnet_name_isvalid(encoding, length, name)) {
|
|
characterstring_init(char_string, encoding, &name[0], length);
|
|
} else if (default_string) {
|
|
characterstring_init_ansi(char_string, default_string);
|
|
}
|
|
}
|