Steve Karg
4924a57ccc
* Added enumeration text lookup for BACnetAuthenticationStatus, BACnetAuthorizationMode, BACnetAccessCredentialDisable, BACnetAccessCredentialDisableReason, BACnetAccessUserType, BACnetAccessZoneOccupancyState, BACnetWriteStatus, BACnetIPMode, BACnetDoorValue, BACnetMaintenance, BACnetEscalatorFault, BACnetEscalatorMode, BACnetEscalatorOperationDirection, BACnetBackupState, BACnetSecurityLevel, BACnetLiftCarDirection, BACnetLiftCarDoorCommand, BACnetLiftCarDriveStatus, BACnetLiftCarMode, BACnetLiftFault, BACnetLiftGroupMode, BACnetAuditLevel, BACnetAuditOperation, BACnetSCHubConnectorState, BACnetSCConnectionState, BACnetNodeRelationship, BACnetAction, BACnetFileAccessMethod, BACnetLockStatus, BACnetDoorAlarmState, BACnetDoorStatus, BACnetDoorSecuredStatus, and BACnetAccessEvent. * Created BINARY_PV_MAX with the same semantic meaning as one more than the last valid enumeration, and deprecated MAX_BINARY_PV usage in the examples. * Reduced code size by using bactext_property_states_strtoul() instead of individual API for each enumations.
472 lines
15 KiB
C
472 lines
15 KiB
C
/**
|
|
* @file
|
|
* @brief BACnet text enumerations lookup functions
|
|
* @author Steve Karg <skarg@users.sourceforge.net>
|
|
* @date 2012
|
|
* @copyright SPDX-License-Identifier: MIT
|
|
*/
|
|
#ifndef BACNET_TEXT_H
|
|
#define BACNET_TEXT_H
|
|
|
|
/* tiny implementations have no need to print */
|
|
#if PRINT_ENABLED
|
|
#define BACTEXT_PRINT_ENABLED
|
|
#endif
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
/* BACnet Stack defines - first */
|
|
#include "bacnet/bacdef.h"
|
|
/* BACnet Stack API */
|
|
#include "bacnet/indtext.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_confirmed_service_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_confirmed_service_name_default(
|
|
uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_confirmed_service_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_unconfirmed_service_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_unconfirmed_service_name_default(
|
|
uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_unconfirmed_service_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_application_tag_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_application_tag_name_default(
|
|
uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_application_tag_index(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_object_type_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_object_type_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_object_type_index(const char *search_name, uint32_t *found_index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_object_type_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_object_type_name_capitalized(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_object_type_name_capitalized_default(
|
|
uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_object_type_name_capitalized_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_property_name_proprietary(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_property_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
uint32_t bactext_property_id(const char *name);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_property_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_property_index(const char *search_name, uint32_t *found_index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_property_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_engineering_unit_name_proprietary(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_engineering_unit_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_engineering_unit_name_default(
|
|
uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_engineering_unit_index(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_reject_reason_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_reject_reason_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_reject_reason_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_abort_reason_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_abort_reason_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_abort_reason_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_error_class_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_error_class_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_error_class_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_error_code_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_error_code_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_error_code_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_month_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_month_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_month_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_week_of_month_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_week_of_month_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_week_of_month_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_day_of_week_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_day_of_week_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_day_of_week_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_days_of_week_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_days_of_week_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_days_of_week_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_notify_type_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_notify_type_name_default(uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_notify_type_index(const char *search_name, uint32_t *found_index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_notify_type_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_event_state_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_event_state_index(const char *search_name, uint32_t *found_index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_event_state_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_event_type_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_event_type_index(const char *search_name, uint32_t *found_index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_event_type_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_binary_present_value_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_binary_present_value_index(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_binary_polarity_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_reliability_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_device_status_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_segmentation_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_segmentation_index(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_node_type_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_node_relationship_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_node_relationship_name_proprietary(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_node_relationship_name_reserved(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_node_relationship_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_character_string_encoding_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_character_string_encoding_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_event_transition_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_event_transition_name_default(
|
|
uint32_t index, const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_event_transition_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_network_layer_msg_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_network_layer_msg_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_life_safety_mode_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_life_safety_operation_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_life_safety_state_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_silenced_state_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_device_communications_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_device_communications_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_lighting_operation_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_lighting_operation_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_binary_lighting_pv_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_binary_lighting_pv_names_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_lighting_in_progress(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_lighting_transition(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_color_operation_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_color_operation_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_shed_state_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_shed_level_type_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_shed_level_type_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_log_datum_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_log_datum_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_restart_reason_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_network_port_type_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_network_number_quality_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_protocol_level_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_network_port_command_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_authentication_decision_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_authentication_decision_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_authorization_posture_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_authorization_posture_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_fault_type_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_fault_type_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_priority_filter_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_priority_filter_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_result_flags_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_result_flags_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_success_filter_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_success_filter_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_logging_type_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_logging_type_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_program_request_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_program_state_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_program_error_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_timer_transition_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_timer_state_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_boolean_value_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_action_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_file_access_method_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_lock_status_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_door_alarm_state_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_door_status_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_door_secured_status_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_access_event_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *
|
|
bactext_access_event_name_default(uint32_t index, const char *default_string);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_authentication_status_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_authorization_mode_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_authorization_mode_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_access_credential_disable_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_access_credential_disable_reason_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_access_user_type_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_access_user_type_strtol(
|
|
const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_access_zone_occupancy_state_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_write_status_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_ip_mode_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_ip_mode_strtol(const char *search_name, uint32_t *found_index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_door_value_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_maintenance_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_escalator_fault_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_escalator_mode_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_escalator_operation_direction_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_backup_state_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_security_level_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_lift_car_direction_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_lift_car_door_command_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_lift_car_drive_status_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_lift_car_mode_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_lift_fault_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_lift_group_mode_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_audit_level_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_audit_operation_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_sc_hub_connector_state_name(uint32_t index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_sc_connection_state_name(uint32_t index);
|
|
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_property_states_strtoul(
|
|
BACNET_PROPERTY_STATES object_property,
|
|
const char *search_name,
|
|
uint32_t *found_index);
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_property_states_name(
|
|
BACNET_PROPERTY_STATES property_state,
|
|
uint32_t index,
|
|
const char *default_string);
|
|
|
|
BACNET_STACK_EXPORT
|
|
const char *bactext_object_property_name(
|
|
BACNET_OBJECT_TYPE object_type,
|
|
BACNET_PROPERTY_ID object_property,
|
|
uint32_t index,
|
|
const char *default_string);
|
|
BACNET_STACK_EXPORT
|
|
bool bactext_object_property_strtoul(
|
|
BACNET_OBJECT_TYPE object_type,
|
|
BACNET_PROPERTY_ID object_property,
|
|
const char *search_name,
|
|
uint32_t *found_index);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif
|