From: saerome.kim Date: Mon, 23 Jul 2018 06:46:03 +0000 (+0900) Subject: Fixed ACR issue X-Git-Tag: accepted/tizen/unified/20180726.064927^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=09cffad6181625b501f1ed595f98cabb43d470f2;p=platform%2Fcore%2Fapi%2Fzigbee.git Fixed ACR issue - changed zb_device_id_e enumeration type to public. - fixed broken link issue - made internal functions and definifions hide. - removed superfluousness '_attributes_e'. Change-Id: I4a75afb6e7aa5ef0cd4fe8f8226d97f1a188b8cb Signed-off-by: saerome.kim --- diff --git a/common/zb-utils.c b/common/zb-utils.c index bffa520..6a8ac07 100644 --- a/common/zb-utils.c +++ b/common/zb-utils.c @@ -81,53 +81,54 @@ const char* zb_end_dev_get_device_id_str(zb_device_id deviceid) { switch (deviceid) { /* General devices */ - CASE_TO_STR(ZB_HA_ON_OFF_SWITCH) - CASE_TO_STR(ZB_HA_LEVEL_CONTROL_SWITCH) - CASE_TO_STR(ZB_HA_ON_OFF_OUTPUT) - CASE_TO_STR(ZB_HA_LEVEL_CONTROLLABLE_OUTPUT) - CASE_TO_STR(ZB_HA_SCENE_SELECOTOR) - CASE_TO_STR(ZB_HA_CONFIGURATION_TOOL) - CASE_TO_STR(ZB_HA_REMOTE_CONTROL) - CASE_TO_STR(ZB_HA_COMBINED_INTERFACE) - CASE_TO_STR(ZB_HA_RANGE_EXTENDER) - CASE_TO_STR(ZB_HA_MAINS_POWER_OUTLET) - CASE_TO_STR(ZB_HA_DOOR_LOCK) - CASE_TO_STR(ZB_HA_DOOR_LOCK_CONTROLLER) - CASE_TO_STR(ZB_HA_SIMPLE_SENSOR) - CASE_TO_STR(ZB_HA_CONSUMPTION_AWARENESS_DEVICE) - CASE_TO_STR(ZB_HA_HOME_GATEWAY) - CASE_TO_STR(ZB_HA_SMART_PLUG) - CASE_TO_STR(ZB_HA_WHITE_GOODS) - CASE_TO_STR(ZB_HA_METER_INTERFACE) + CASE_TO_STR(ZB_HA_DEV_ON_OFF_SWITCH) + CASE_TO_STR(ZB_HA_DEV_LEVEL_CONTROL_SWITCH) + CASE_TO_STR(ZB_HA_DEV_ON_OFF_OUTPUT) + CASE_TO_STR(ZB_HA_DEV_LEVEL_CONTROLLABLE_OUTPUT) + CASE_TO_STR(ZB_HA_DEV_SCENE_SELECTOR) + CASE_TO_STR(ZB_HA_DEV_CONFIGURATION_TOOL) + CASE_TO_STR(ZB_HA_DEV_REMOTE_CONTROL) + CASE_TO_STR(ZB_HA_DEV_COMBINED_INTERFACE) + CASE_TO_STR(ZB_HA_DEV_RANGE_EXTENDER) + CASE_TO_STR(ZB_HA_DEV_MAINS_POWER_OUTLET) + CASE_TO_STR(ZB_HA_DEV_DOOR_LOCK) + CASE_TO_STR(ZB_HA_DEV_DOOR_LOCK_CONTROLLER) + CASE_TO_STR(ZB_HA_DEV_SIMPLE_SENSOR) + CASE_TO_STR(ZB_HA_DEV_CONSUMPTION_AWARENESS_DEVICE) + CASE_TO_STR(ZB_HA_DEV_HOME_GATEWAY) + CASE_TO_STR(ZB_HA_DEV_SMART_PLUG) + CASE_TO_STR(ZB_HA_DEV_WHITE_GOODS) + CASE_TO_STR(ZB_HA_DEV_METER_INTERFACE) /* Lighting devices */ - CASE_TO_STR(ZB_HA_ON_OFF_LIGHT) - CASE_TO_STR(ZB_HA_DIMMABLE_LIGHT) - CASE_TO_STR(ZB_HA_COLOR_DIMMABLE_LIGHT) - CASE_TO_STR(ZB_HA_ON_OFF_LIGHT_SWITCH) - CASE_TO_STR(ZB_HA_DIMMER_SWITCH) - CASE_TO_STR(ZB_HA_COLOR_DIMMER_SWITCH) - CASE_TO_STR(ZB_HA_LIGHT_SENSOR) - CASE_TO_STR(ZB_HA_OCUPANCY_SENSOR) + CASE_TO_STR(ZB_HA_DEV_ON_OFF_LIGHT) + CASE_TO_STR(ZB_HA_DEV_DIMMABLE_LIGHT) + CASE_TO_STR(ZB_HA_DEV_COLOR_DIMMABLE_LIGHT) + CASE_TO_STR(ZB_HA_DEV_ON_OFF_LIGHT_SWITCH) + CASE_TO_STR(ZB_HA_DEV_DIMMER_SWITCH) + CASE_TO_STR(ZB_HA_DEV_COLOR_DIMMER_SWITCH) + CASE_TO_STR(ZB_HA_DEV_LIGHT_SENSOR) + CASE_TO_STR(ZB_HA_DEV_OCCUPANCY_SENSOR) /* Closures devices */ - CASE_TO_STR(ZB_HA_SHADE) - CASE_TO_STR(ZB_HA_SHADE_CONTROLLER) - CASE_TO_STR(ZB_HA_WINDOW_COVERING_DEVICE) - CASE_TO_STR(ZB_HA_WINDOW_COVERING_CONTROLLER) + CASE_TO_STR(ZB_HA_DEV_SHADE) + CASE_TO_STR(ZB_HA_DEV_SHADE_CONTROLLER) + CASE_TO_STR(ZB_HA_DEV_WINDOW_COVERING_DEVICE) + CASE_TO_STR(ZB_HA_DEV_WINDOW_COVERING_CONTROLLER) /* HVAC devices */ - CASE_TO_STR(ZB_HA_HEATING_COOLLING_UNIT) - CASE_TO_STR(ZB_HA_THERMOSTAT) - CASE_TO_STR(ZB_HA_TEMPERATURE_SENSOR) - CASE_TO_STR(ZB_HA_PUMP) - CASE_TO_STR(ZB_HA_PUMP_CONTROLLER) - CASE_TO_STR(ZB_HA_PRESSURE_SENSOR) - CASE_TO_STR(ZB_HA_FLOW_SENSOR) - CASE_TO_STR(ZB_HA_MINI_SPLIT_AC) + CASE_TO_STR(ZB_HA_DEV_HEATING_COOLING_UNIT) + CASE_TO_STR(ZB_HA_DEV_THERMOSTAT) + CASE_TO_STR(ZB_HA_DEV_TEMPERATURE_SENSOR) + CASE_TO_STR(ZB_HA_DEV_PUMP) + CASE_TO_STR(ZB_HA_DEV_PUMP_CONTROLLER) + CASE_TO_STR(ZB_HA_DEV_PRESSURE_SENSOR) + CASE_TO_STR(ZB_HA_DEV_FLOW_SENSOR) + CASE_TO_STR(ZB_HA_DEV_MINI_SPLIT_AC) /* Intruder Alarms system */ - CASE_TO_STR(ZB_HA_IAS_CONTROL_AND_INDICATING_EQUIPMENT) - CASE_TO_STR(ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT) - CASE_TO_STR(ZB_HA_IAS_ZONE) + CASE_TO_STR(ZB_HA_DEV_IAS_CONTROL_AND_INDICATING_EQUIPMENT) + CASE_TO_STR(ZB_HA_DEV_IAS_ANCILLARY_CONTROL_EQUIPMENT) + CASE_TO_STR(ZB_HA_DEV_IAS_ZONE) + CASE_TO_STR(ZB_HA_DEV_IAS_WARNING_DEVICE) default : - return "ZB_HA_UNKNOWN_DEVICE"; + return "ZB_HA_DEV_UNKNOWN_DEVICE"; } } diff --git a/include/zigbee-zcl-type.h b/include/zigbee-zcl-type.h index 8e83734..1ad28da 100644 --- a/include/zigbee-zcl-type.h +++ b/include/zigbee-zcl-type.h @@ -122,22 +122,6 @@ typedef enum { } zb_zcl_broadcast_address_e; /** - * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE - * @brief Uses this value as the return value to stop foreach function. - * - * @since_tizen 4.0 - */ -#define ZIGBEE_FUNC_STOP false - -/** - * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE - * @brief Uses this value as the return value to continue foreach function. - * - * @since_tizen 4.0 - */ -#define ZIGBEE_FUNC_CONTINUE true - -/** * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_GLOBAL_COMMAND_MODULE * @brief ACL type. * @@ -455,7 +439,7 @@ typedef enum { ZB_ZCL_ATTR_ALARM_MASK = 0x0013, /**< Alarm mask */ ZB_ZCL_ATTR_DISABLE_LOCAL_CONFIG = 0x0014, /**< Disable local config */ ZB_ZCL_ATTR_SW_BUILD_ID = 0x4000, /**< SW build id ((since zll-1.0-11-0037-10)) */ -} zb_zcl_attribute_basic_e; +} zb_zcl_attr_basic_e; /** * @brief Attribute types for cluster: Power Configuration. @@ -521,7 +505,7 @@ typedef enum { ZB_ZCL_ATTR_BATTERY_3_PERCENTAGE_THRESHOLD_2 = 0x007C, /**< Battery 3 percentage threshold 2 (since ha-1.2-05-3520-29) */ ZB_ZCL_ATTR_BATTERY_3_PERCENTAGE_THRESHOLD_3 = 0x007D, /**< Battery 3 percentage threshold 3 (since ha-1.2-05-3520-29) */ ZB_ZCL_ATTR_BATTERY_3_ALARM_STATE = 0x007E, /**< Battery 3 alarm state (since ha-1.2-05-3520-29) */ -} zb_zcl_attribute_power_configuration_e; +} zb_zcl_attr_power_configuration_e; /** * @brief Attribute types for cluster: Device Temperature Configuration. @@ -539,7 +523,7 @@ typedef enum { ZB_ZCL_ATTR_HIGH_TEMP_THRESHOLD = 0x0012, /**< High temp. threshold */ ZB_ZCL_ATTR_LOW_TEMP_DWELL_TRIP_POINT = 0x0013, /**< Low temp. dwell trip point */ ZB_ZCL_ATTR_HIGH_TEMP_DWELL_TRIP_POINT = 0x0014, /**< High temp. dwell trip point */ -} zb_zcl_attribute_device_temperature_configuration_e; +} zb_zcl_attr_device_temperature_configuration_e; /** * @brief Attribute types for cluster: Identify. @@ -550,7 +534,7 @@ typedef enum { typedef enum { ZB_ZCL_ATTR_IDENTIFY_TIME = 0x0000, /**< Identity time */ ZB_ZCL_ATTR_COMMISSION_STATE = 0x0001, /**< Commission state */ -} zb_zcl_attribute_identify_e; +} zb_zcl_attr_identify_e; /** * @brief Attribute types for cluster: Groups. @@ -560,7 +544,7 @@ typedef enum { */ typedef enum { ZB_ZCL_ATTR_GROUP_NAME_SUPPORT = 0x0000, /**< Group name support */ -} zb_zcl_attribute_group_e; +} zb_zcl_attr_group_e; /** * @brief Attribute types for cluster: Scenes. @@ -575,7 +559,7 @@ typedef enum { ZB_ZCL_ATTR_SCENE_VALID = 0x0003, /**< Scene valid */ ZB_ZCL_ATTR_SCENE_NAME_SUPPORT = 0x0004, /**< Scene name support */ ZB_ZCL_ATTR_LAST_CONFIGURED_BY = 0x0005, /**< Last configured by */ -} zb_zcl_attribute_scenes_e; +} zb_zcl_attr_scenes_e; /** * @brief Attribute types for cluster: On/off. @@ -589,7 +573,7 @@ typedef enum { ZB_ZCL_ATTR_GLOBAL_SCENE_CONTROL = 0x4000, /**< Global scene control (since zll-1.0-11-0037-10) */ ZB_ZCL_ATTR_ON_TIME = 0x4001, /**< On time (since zll-1.0-11-0037-10) */ ZB_ZCL_ATTR_OFF_WAIT_TIME = 0x4002, /**< Off wait time (since zll-1.0-11-0037-10) */ -} zb_zcl_attribute_on_off_e; +} zb_zcl_attr_on_off_e; /** * @brief Attribute types for cluster: On/off Switch Configuration. @@ -600,7 +584,7 @@ typedef enum { typedef enum { ZB_ZCL_ATTR_SWITCH_TYPE = 0x0000, /**< Switch type */ ZB_ZCL_ATTR_SWITCH_ACTIONS = 0x0010, /**< Switch actions */ -} zb_zcl_attribute_on_off_switch_configuration_e; +} zb_zcl_attr_on_off_switch_configuration_e; /** * @brief Attribute types for cluster: Level Control. @@ -616,7 +600,7 @@ typedef enum { ZB_ZCL_ATTR_ON_TRANSITION_TIME = 0x0012, /**< On transition time (since ha-1.2-05-3520-29) */ ZB_ZCL_ATTR_OFF_TRANSITION_TIME = 0x0013, /**< Off transition time (since ha-1.2-05-3520-29) */ ZB_ZCL_ATTR_DEFAULT_MOVE_RATE = 0x0014, /**< Default move rate (since ha-1.2-05-3520-29) */ -} zb_zcl_attribute_level_control_e; +} zb_zcl_attr_level_control_e; /** * @brief Attribute types for cluster: Alarms. @@ -626,7 +610,7 @@ typedef enum { */ typedef enum { ZB_ZCL_ATTR_ALARM_COUNT = 0x0000, /**< alarm count */ -} zb_zcl_attribute_alarms_e; +} zb_zcl_attr_alarms_e; /** * @brief Attribute types for cluster: Time. @@ -645,7 +629,7 @@ typedef enum { ZB_ZCL_ATTR_LOCAL_TIME = 0x0007, /**< Local time. The value 0xffffffff indicates an invalid Local Time. */ ZB_ZCL_ATTR_LAST_SET_TIME = 0x0008, /**< The most recent time that the Time attribute was set, either internally or over the ZigBee network. The value 0xffffffff indicates an invalid lst set Time*/ ZB_ZCL_ATTR_VALID_UNTIL_TIME = 0x0009, /**< Valid until time indicates a time, later than LastSetTime, up to which the Time attribute may be trusted. 'Trusted' means that the difference between the Time attribute and the true UTC time is less than an acceptable error. */ -} zb_zcl_attribute_time_e; +} zb_zcl_attr_time_e; /** * @brief Attribute types for cluster: RSSI Location. @@ -667,7 +651,7 @@ typedef enum { ZB_ZCL_ATTR_REPORTING_PERIOD = 0x0015, /**< Reporting period */ ZB_ZCL_ATTR_CALCULATION_PERIOD = 0x0016, /**< Calculation period */ ZB_ZCL_ATTR_NUMBER_OF_RSSI_MEASUREMENTS = 0x0017, /**< Number of RSSI measurements */ -} zb_zcl_attribute_rssi_location_e; +} zb_zcl_attr_rssi_location_e; /** * @brief Attribute types for cluster: Binary Input (Basic). @@ -685,7 +669,7 @@ typedef enum { ZB_ZCL_ATTR_RELIABILITY = 0x0067, /**< Reliability */ ZB_ZCL_ATTR_STATUS_FLAGS = 0x006F, /**< Status flag */ ZB_ZCL_ATTR_APPLICATION_TYPE = 0x0100, /**< Application type */ -} zb_zcl_attribute_binary_input_basic_e; +} zb_zcl_attr_binary_input_basic_e; /** * @brief Attribute types for cluster: Commissioning. @@ -718,7 +702,7 @@ typedef enum { ZB_ZCL_ATTR_CONCENTRATOR_FLAG = 0x0040, /**< Concentrator flag */ ZB_ZCL_ATTR_CONCENTRATOR_RADIUS = 0x0041, /**< Concentrator radius */ ZB_ZCL_ATTR_CONCENTRATOR_DISCOVERY_TIME = 0x0042, /**< Concentrator discovery time */ -} zb_zcl_attribute_commissioning_e; +} zb_zcl_attr_commissioning_e; /** * @brief Attribute types for cluster: Partition. @@ -737,7 +721,7 @@ typedef enum { ZB_ZCL_ATTR_NUMBER_OF_SEND_RETRIES = 0x0007, /**< Number of send retries */ ZB_ZCL_ATTR_SENDER_TIMEOUT = 0x0008, /**< Sender timeout */ ZB_ZCL_ATTR_RECEIVER_TIMEOUT = 0x0009, /**< Receiver timeout */ -} zb_zcl_attribute_partition_e; +} zb_zcl_attr_partition_e; /** * @brief Attribute types for cluster: Over the Air Bootloading. @@ -757,7 +741,7 @@ typedef enum { ZB_ZCL_ATTR_IMAGE_TYPE_ID = 0x0008, /**< Image type ID */ ZB_ZCL_ATTR_MINIMUM_BLOCK_REQUEST_PERIOD = 0x0009, /**< Minimum block request period (since ha-1.2-05-3520-29) */ ZB_ZCL_ATTR_IMAGE_STAMP = 0x000A, /**< Image stamp (since ha-1.2-05-3520-29) */ -} zb_zcl_attribute_over_the_air_bootloading_client_attributes_e; +} zb_zcl_attr_over_the_air_bootloading_client_e; /** * @brief Attribute types for cluster: Power Profile. @@ -771,7 +755,7 @@ typedef enum { ZB_ZCL_ATTR_ENERGY_FORMATTING = 0x0002, /**< Energy formatting */ ZB_ZCL_ATTR_ENERGY_REMOTE = 0x0003, /**< Energy remote */ ZB_ZCL_ATTR_SCHEDULE_MODE = 0x0004, /**< Schedule mode */ -} zb_zcl_attribute_power_profile_e; +} zb_zcl_attr_power_profile_e; /** * @brief Attribute types for cluster: Appliance Control. @@ -783,7 +767,7 @@ typedef enum { ZB_ZCL_ATTR_START_TIME = 0x0000, /**< Start time */ ZB_ZCL_ATTR_FINISH_TIME = 0x0001, /**< Finish time */ ZB_ZCL_ATTR_REMAINING_TIME = 0x0002, /**< Remaining time */ -} zb_zcl_attribute_appliance_control_e; +} zb_zcl_attr_appliance_control_e; /** * @brief Attribute types for cluster: Poll Control. @@ -799,7 +783,7 @@ typedef enum { ZB_ZCL_ATTR_CHECK_IN_INTERVAL_MIN = 0x0004, /**< Check-in interval min. */ ZB_ZCL_ATTR_LONG_POLL_INTERVAL_MIN = 0x0005, /**< Long poll interval min. */ ZB_ZCL_ATTR_FAST_POLL_TIMEOUT_MAX = 0x0006, /**< Fast poll interval max. */ -} zb_zcl_attribute_poll_control_e; +} zb_zcl_attr_poll_control_e; /** * @brief Attribute types for cluster: Shade Configuration. @@ -813,7 +797,7 @@ typedef enum { ZB_ZCL_ATTR_SHADE_CONFIG_STATUS = 0x0002, /**< Shade config status */ ZB_ZCL_ATTR_SHADE_CONFIG_CLOSED_LIMIT = 0x0010, /**< Shade config close limit */ ZB_ZCL_ATTR_SHADE_CONFIG_MODE = 0x0011, /**< Shade config mode */ -} zb_zcl_attribute_shade_configuration_e; +} zb_zcl_attr_shade_configuration_e; /** * @brief Attribute types for cluster: Door Lock. @@ -865,7 +849,7 @@ typedef enum { ZB_ZCL_ATTR_KEYPAD_PROGRAMMING_EVENT_MASK = 0x0045, /**< Keypad programming event mask (since ha-1.2-05-3520-29) */ ZB_ZCL_ATTR_RF_PROGRAMMING_EVENT_MASK = 0x0046, /**< RF programming event mask (since ha-1.2-05-3520-29) */ ZB_ZCL_ATTR_RFID_PROGRAMMING_EVENT_MASK = 0x0047, /**< RFID programming event mask (since ha-1.2-05-3520-29) */ -} zb_zcl_attribute_door_lock_e; +} zb_zcl_attr_door_lock_e; /** * @brief Attribute types for cluster: Window Covering. @@ -894,7 +878,7 @@ typedef enum { ZB_ZCL_ATTR_MODE = 0x0017, /**< Mode */ ZB_ZCL_ATTR_SETPOINTS_LIFT = 0x0018, /**< Setpoints lift */ ZB_ZCL_ATTR_SETPOINTS_TILT = 0x0019, /**< Setpoints tilt */ -} zb_zcl_attribute_window_covering_e; +} zb_zcl_attr_window_covering_e; /** * @brief Attribute types for cluster: Pump Configuration and Control. @@ -927,7 +911,7 @@ typedef enum { ZB_ZCL_ATTR_OPERATION_MODE = 0x0020, /**< Operation mode */ ZB_ZCL_ATTR_CONTROL_MODE = 0x0021, /**< Control mode */ ZB_ZCL_ATTR_PUMP_ALARM_MASK = 0x0022, /**< Pump alarm mask */ -} zb_zcl_attribute_pump_configuration_and_control_e; +} zb_zcl_attr_pump_configuration_and_control_e; /** * @brief Attribute types for cluster: Thermostat. @@ -979,7 +963,7 @@ typedef enum { ZB_ZCL_ATTR_AC_LOUVER_POSITION = 0x0045, /**< AC louver position (since ha-1.2-05-3520-29) */ ZB_ZCL_ATTR_AC_COIL_TEMPERATURE = 0x0046, /**< AC coil temperature (since ha-1.2-05-3520-29) */ ZB_ZCL_ATTR_AC_CAPACITY_FORMAT = 0x0047, /**< AC capacity format (since ha-1.2-05-3520-29) */ -} zb_zcl_attribute_thermostat_e; +} zb_zcl_attr_thermostat_e; /** * @brief Attribute types for cluster: Fan Control. @@ -990,7 +974,7 @@ typedef enum { typedef enum { ZB_ZCL_ATTR_FAN_CONTROL_FAN_MODE = 0x0000, /**< Fan mode */ ZB_ZCL_ATTR_FAN_CONTROL_FAN_MODE_SEQUENCE = 0x0001, /**< Fan mode sequence */ -} zb_zcl_attribute_fan_control_e; +} zb_zcl_attr_fan_control_e; /** * @brief Attribute types for cluster: Dehumidification Control. @@ -1007,7 +991,7 @@ typedef enum { ZB_ZCL_ATTR_DEHUMIDIFICATION_HYSTERESIS = 0x0013, /**< Dehumidification hysteresis */ ZB_ZCL_ATTR_DEHUMIDIFICATION_MAX_COOL = 0x0014, /**< Dehumidification max. cool */ ZB_ZCL_ATTR_RELATIVE_HUMIDITY_DISPLAY = 0x0015, /**< Relative humidity display */ -} zb_zcl_attribute_dehumidification_control_attributes_e; +} zb_zcl_attr_dehumidification_control_e; /** * @brief Attribute types for cluster: Thermostat User Interface Configuration. @@ -1019,7 +1003,7 @@ typedef enum { ZB_ZCL_ATTR_TEMPERATURE_DISPLAY_MODE = 0x0000, /**< Temperature display mode */ ZB_ZCL_ATTR_KEYPAD_LOCKOUT = 0x0001, /**< Keypad lockout */ ZB_ZCL_ATTR_SCHEDULE_PROGRAMMING_VISIBILITY = 0x0002, /**< Schedule programming visibility (since ha-1.2-05-3520-29) */ -} zb_zcl_attribute_thermostat_user_interface_configuration_e; +} zb_zcl_attr_thermostat_user_interface_configuration_e; /** * @brief Attribute types for cluster: Color Control. @@ -1077,7 +1061,7 @@ typedef enum { ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_CAPABILITIES = 0x400A, /**< Color capabilities (since zll-1.0-11-0037-10) */ ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MIN = 0x400B, /**< Color temp. physical min. (since zll-1.0-11-0037-10) */ ZB_ZCL_ATTR_COLOR_CONTROL_COLOR_TEMP_PHYSICAL_MAX = 0x400C, /**< Color temp. physical max. (since zll-1.0-11-0037-10) */ -} zb_zcl_attribute_color_control_e; +} zb_zcl_attr_color_control_e; /** * @brief Attribute types for cluster: Ballast Configuration. @@ -1102,7 +1086,7 @@ typedef enum { ZB_ZCL_ATTR_LAMP_BURN_HOURS = 0x0033, /**< Lamp burn hours */ ZB_ZCL_ATTR_LAMP_ALARM_MODE = 0x0034, /**< Lamp alarm mode */ ZB_ZCL_ATTR_LAMP_BURN_HOURS_TRIP_POINT = 0x0035, /**< Lamp burn hours */ -} zb_zcl_attribute_ballast_configuration_e; +} zb_zcl_attr_ballast_configuration_e; /** * @brief Attribute types for cluster: Illuminance Measurement. @@ -1116,7 +1100,7 @@ typedef enum { ZB_ZCL_ATTR_ILLUM_MAX_MEASURED_VALUE = 0x0002, /**< Illuminance Max. measured value */ ZB_ZCL_ATTR_ILLUM_TOLERANCE = 0x0003, /**< Illuminance Tolerance */ ZB_ZCL_ATTR_MEASUREMENT_LIGHT_SENSOR_TYPE = 0x0004, /**< Measurement light sensor type */ -} zb_zcl_attribute_illuminance_measurement_e; +} zb_zcl_attr_illuminance_measurement_e; /** * @brief Attribute types for cluster: Illuminance Level Sensing. @@ -1128,7 +1112,7 @@ typedef enum { ZB_ZCL_ATTR_ILLUMINANCE_LEVEL_STATUS = 0x0000, /**< Illuminance level status */ ZB_ZCL_ATTR_ILLUMINANCE_SENSING_LIGHT_SENSOR_TYPE = 0x0001, /**< Illuminance sensing light sensor type */ ZB_ZCL_ATTR_ILLUMINANCE_TARGET_LEVEL = 0x0010, /**< Illuminance target level */ -} zb_zcl_attribute_illuminance_level_sensing_e; +} zb_zcl_attr_illuminance_level_sensing_e; /** * @brief Attribute types for cluster: Temperature Measurement. @@ -1141,7 +1125,7 @@ typedef enum { ZB_ZCL_ATTR_TEMP_MIN_MEASURED_VALUE = 0x0001, /**< Min. measured value */ ZB_ZCL_ATTR_TEMP_MAX_MEASURED_VALUE = 0x0002, /**< Max. measured value */ ZB_ZCL_ATTR_TEMP_TOLERANCE = 0x0003, /**< Tolerance */ -} zb_zcl_attribute_temperature_measurement_e; +} zb_zcl_attr_temperature_measurement_e; /** * @brief Attribute types for cluster: Pressure Measurement. @@ -1159,7 +1143,7 @@ typedef enum { ZB_ZCL_ATTR_PRESSURE_MAX_SCALED_VALUE = 0x0012, /**< Max. scaled value */ ZB_ZCL_ATTR_PRESSURE_SCALED_TOLERANCE = 0x0013, /**< Scaled tolerance */ ZB_ZCL_ATTR_PRESSURE_SCALE = 0x0014, /**< Scale */ -} zb_zcl_attribute_pressure_measurement_e; +} zb_zcl_attr_pressure_measurement_e; /** * @brief Attribute types for cluster: Flow Measurement. @@ -1172,7 +1156,7 @@ typedef enum { ZB_ZCL_ATTR_FLOW_MIN_MEASURED_VALUE = 0x0001, /**< Min. measured value */ ZB_ZCL_ATTR_FLOW_MAX_MEASURED_VALUE = 0x0002, /**< Max. measured value */ ZB_ZCL_ATTR_FLOW_TOLERANCE = 0x0003, /**< Tolerance */ -} zb_zcl_attribute_flow_measurement_e; +} zb_zcl_attr_flow_measurement_e; /** * @brief Attribute types for cluster: Relative Humidity Measurement. @@ -1185,7 +1169,7 @@ typedef enum { ZB_ZCL_ATTR_RELATIVE_HUMIDITY_MIN_MEASURED_VALUE = 0x0001, /**< Min. measured value */ ZB_ZCL_ATTR_RELATIVE_HUMIDITY_MAX_MEASURED_VALUE = 0x0002, /**< Max. measured value */ ZB_ZCL_ATTR_RELATIVE_HUMIDITY_TOLERANCE = 0x0003, /**< Tolerance */ -} zb_zcl_attribute_relative_humidity_measurement_e; +} zb_zcl_attr_relative_humidity_measurement_e; /** * @brief Attribute types for cluster: Occupancy Sensing. @@ -1202,7 +1186,7 @@ typedef enum { ZB_ZCL_ATTR_ULTRASONIC_OCCUPIED_TO_UNOCCUPIED_DELAY = 0x0020, /**< Ultrasonic occupied to unoccupied delay */ ZB_ZCL_ATTR_ULTRASONIC_UNOCCUPIED_TO_OCCUPIED_DELAY = 0x0021, /**< Ultrasonic unoccupied to occupied delay */ ZB_ZCL_ATTR_ULTRASONIC_UNOCCUPIED_TO_OCCUPIED_THRESHOLD = 0x0022, /**< Ultrasonic unoccupied to occupied threshold */ -} zb_zcl_attribute_occupancy_sensing_measurement_e; +} zb_zcl_attr_occupancy_sensing_measurement_e; /** * @brief Attribute types for cluster: IAS Zone. @@ -1218,7 +1202,7 @@ typedef enum { ZB_ZCL_ATTR_ZONE_ID = 0x0011, /**< Zone ID */ ZB_ZCL_ATTR_NUMBER_OF_ZONE_SENSITIVITY_LEVELS_SUPPORTED = 0x0012, /**< Number of zone sensitivity levels supported */ ZB_ZCL_ATTR_CURRENT_ZONE_SENSITIVITY_LEVEL = 0x0013, /**< Current zone sensitivity level */ -} zb_zcl_attribute_ias_zone_server_e; +} zb_zcl_attr_ias_zone_server_e; /** * @brief Attribute types for cluster: IAS WD. @@ -1228,7 +1212,7 @@ typedef enum { */ typedef enum { ZB_ZCL_ATTR_MAX_DURATION = 0x0000, /**< Max. duration */ -} zb_zcl_attribute_ias_wd_server_e; +} zb_zcl_attr_ias_wd_server_e; /** * @brief Attribute types for cluster: Electrical Measurement. @@ -1365,7 +1349,7 @@ typedef enum { ZB_ZCL_ATTR_RMS_EXTREME_UNDER_VOLTAGE_PERIOD_PHASE_C = 0x0A15, /**< RMS extreme under voltage period phase C */ ZB_ZCL_ATTR_RMS_VOLTAGE_SAG_PERIOD_PHASE_C = 0x0A16, /**< RMS voltage sag period phase C */ ZB_ZCL_ATTR_RMS_VOLTAGE_SWELL_PERIOD_PHASE_C = 0x0A17, /**< RMS voltage swell period phase C */ -} zb_zcl_attribute_electrical_measurement_e; +} zb_zcl_attr_electrical_measurement_e; /** * @brief Attribute types for cluster: Diagnostics. @@ -1406,7 +1390,7 @@ typedef enum { ZB_ZCL_ATTR_SC_AVERAGE_MAC_RETRY_PER_APS_MSG_SENT = 0x011B, /**< Average MAC retry per APS message sent */ ZB_ZCL_ATTR_SC_LAST_MESSAGE_LQI = 0x011C, /**< Last message LQI */ ZB_ZCL_ATTR_SC_LAST_MESSAGE_RSSI = 0x011D, /**< Last message RSSI */ -} zb_zcl_attribute_diagnostics_e; +} zb_zcl_attr_diagnostics_e; /** diff --git a/include/zigbee-zcl_private.h b/include/zigbee-zcl_private.h index b337f65..b252750 100644 --- a/include/zigbee-zcl_private.h +++ b/include/zigbee-zcl_private.h @@ -52,7 +52,7 @@ typedef void* zb_zcl_write_attr_structured_record_h; * * @since_tizen 4.0 */ -typedef void* zb_zcl_attribute_array_h; +typedef void* zb_zcl_attr_array_h; /** * @internal diff --git a/include/zigbee-zdo-type.h b/include/zigbee-zdo-type.h index 094be9a..072e42b 100644 --- a/include/zigbee-zdo-type.h +++ b/include/zigbee-zdo-type.h @@ -167,14 +167,6 @@ typedef enum { /** * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE - * @brief Fields of the Node Descriptor. - * @details Type and capabilities of the node. - * @since_tizen 4.0 - */ -typedef void* zb_zdo_node_descriptor_h; - -/** - * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE * @brief Values of the Current Power Mode Field in Zigbee Specification. * @since_tizen 4.0 */ @@ -209,30 +201,6 @@ typedef enum { /** * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE - * @brief Binding type. - * @since_tizen 4.0 - */ -typedef enum { - ZB_ZDP_BINDING_TYPE_UNICAST = 0x03, /**< A unicast binding whose 64-bit identifier - is the destination #zb_ieee_addr. */ - ZB_ZDP_BINDING_TYPE_MANY_TO_ONE = 0x83, /**< A unicast binding whose 64-bit - identifier is the many-to-one destination #zb_ieee_addr. A Route discovery should be - disabled when sending unicast via may-to-one binding */ - ZB_ZDP_BINDING_TYPE_MULTICAST = 0x01, /**< A multicast binding whose 64-bit - identifier is the group address. A multicast binding can be used to send messages to - the group and to receive message sent to the group */ -} zb_zdp_binding_type_e; - -/** - * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE - * @brief The Node Power Descriptor in Zigbee Specification. - * @details Node power characteristics. - * @since_tizen 4.0 - */ -typedef void* zb_zdo_node_power_descriptor_h; - -/** - * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE * @brief Cluster counts to handle with. * * @since_tizen 4.0 @@ -241,14 +209,6 @@ typedef void* zb_zdo_node_power_descriptor_h; /** * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE - * @brief The handle of zigbee simple description. - * @details Device descriptions contained in node. - * @since_tizen 4.0 - */ -typedef void* zb_zdo_simple_desc_h; - -/** - * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE * @brief The handle of zigbee end-device information. * @details A #zb_end_dev_info_h is an opaque data structure. * #zb_end_dev_info_h is a data type of network address, IEEE address, endpoint count @@ -257,5 +217,12 @@ typedef void* zb_zdo_simple_desc_h; */ typedef void* zb_end_dev_info_h; +/** + * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_DEVICE_DISCOVERY_MODULE + * @brief The handle of zigbee simple description. + * @details Device descriptions contained in node. + * @since_tizen 4.0 + */ +typedef void* zb_zdo_simple_desc_h; #endif /* __TIZEN_CAPI_NETWORK_ZIGBEE_ZDO_TYPE_H__ */ diff --git a/include/zigbee-zdo_internal.h b/include/zigbee-zdo_internal.h index b6904b5..b677896 100644 --- a/include/zigbee-zdo_internal.h +++ b/include/zigbee-zdo_internal.h @@ -19,6 +19,25 @@ #include +/** + * @internal + * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_DEVICE_DISCOVERY_MODULE + * @brief Fields of the Node Descriptor. + * @details Type and capabilities of the node. + * @since_tizen 4.0 + */ +typedef void* zb_zdo_node_descriptor_h; + + +/** + * @internal + * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_DEVICE_DISCOVERY_MODULE + * @brief The Node Power Descriptor in Zigbee Specification. + * @details Node power characteristics. + * @since_tizen 4.0 + */ +typedef void* zb_zdo_node_power_descriptor_h; + ////////////////////////////////////////////////////////////////////////////////////////// /** @@ -47,7 +66,30 @@ /** * @internal - * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE + * @addtogroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE + * @{ + */ + +/** + * @internal + * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE + * @brief Binding type. + * @since_tizen 4.0 + */ +typedef enum { + ZB_ZDP_BINDING_TYPE_UNICAST = 0x03, /**< A unicast binding whose 64-bit identifier + is the destination #zb_ieee_addr. */ + ZB_ZDP_BINDING_TYPE_MANY_TO_ONE = 0x83, /**< A unicast binding whose 64-bit + identifier is the many-to-one destination #zb_ieee_addr. A Route discovery should be + disabled when sending unicast via may-to-one binding */ + ZB_ZDP_BINDING_TYPE_MULTICAST = 0x01, /**< A multicast binding whose 64-bit + identifier is the group address. A multicast binding can be used to send messages to + the group and to receive message sent to the group */ +} zb_zdp_binding_type_e; + +/** + * @internal + * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE * @brief NetworkList Record Format in Zigbee Specification. * @since_tizen 4.0 */ @@ -55,7 +97,7 @@ typedef void* zb_zdo_network_list_record_h; /** * @internal - * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE + * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE * @brief NeighborTableList Record Format in Zigbee Specification. * @since_tizen 4.0 */ @@ -63,7 +105,7 @@ typedef void* zb_zdo_neighbor_table_desc_h; /** * @internal - * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE + * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE * @brief RoutingTableList Record Format in Zigbee Specification. * @since_tizen 4.0 */ @@ -71,7 +113,7 @@ typedef void* zb_zdo_routing_table_h; /** * @internal - * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE + * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE * @brief BindingTableList Record Format in Zigbee Specification. * @since_tizen 4.0 */ @@ -79,17 +121,12 @@ typedef void* zb_zdo_binding_table_h; /** * @internal - * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE + * @ingroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE * @brief DiscoveryCacheList Record Format in Zigbee Specification. * @since_tizen 4.0 */ typedef void* zb_zdo_discovery_cache_h; -/** - * @internal - * @addtogroup CAPI_NETWORK_ZIGBEE_ZDO_BINDING_MANAGER_MODULE - * @{ - */ /** * @internal diff --git a/include/zigbee.h b/include/zigbee.h index ffe12b0..1fa4d76 100644 --- a/include/zigbee.h +++ b/include/zigbee.h @@ -40,6 +40,65 @@ typedef enum { ZB_PROFILE_HOME_AUTOMATION = 0x0104, /**< Zigbee Home Automation profile */ } zb_profile_id_e; +/** + * @brief The device-specified HA profile. + * + * @since_tizen 4.0 + */ +typedef enum { + /* General devices */ + ZB_HA_DEV_ON_OFF_SWITCH = 0x0000, /**< On/off switch device */ + ZB_HA_DEV_LEVEL_CONTROL_SWITCH = 0x0001, /**< Level control device */ + ZB_HA_DEV_ON_OFF_OUTPUT = 0x0002, /**< On/off output device */ + ZB_HA_DEV_LEVEL_CONTROLLABLE_OUTPUT = 0x0003, /**< Controllable output device */ + ZB_HA_DEV_SCENE_SELECTOR = 0x0004, /**< Scene selector device */ + ZB_HA_DEV_CONFIGURATION_TOOL = 0x0005, /**< Configuration tool device */ + ZB_HA_DEV_REMOTE_CONTROL = 0x0006, /**< Remote control device */ + ZB_HA_DEV_COMBINED_INTERFACE = 0x0007, /**< Combined interface device */ + ZB_HA_DEV_RANGE_EXTENDER = 0x0008, /**< Range extender device */ + ZB_HA_DEV_MAINS_POWER_OUTLET = 0x0009, /**< Mains power outlet device */ + ZB_HA_DEV_DOOR_LOCK = 0x000A, /**< Door lock device */ + ZB_HA_DEV_DOOR_LOCK_CONTROLLER = 0x000B, /**< Door lock controller device */ + ZB_HA_DEV_SIMPLE_SENSOR = 0x000C, /**< Simple sensor device */ + ZB_HA_DEV_CONSUMPTION_AWARENESS_DEVICE = 0x000D, /**< Consumption awareness device */ + ZB_HA_DEV_HOME_GATEWAY = 0x0050, /**< Home gateway device */ + ZB_HA_DEV_SMART_PLUG = 0x0051, /**< Smart plug device */ + ZB_HA_DEV_WHITE_GOODS = 0x0052, /**< White goods device */ + ZB_HA_DEV_METER_INTERFACE = 0x0053, /**< Meter interface device */ + + /* Lighting devices */ + ZB_HA_DEV_ON_OFF_LIGHT = 0x0100, /**< On/off light device */ + ZB_HA_DEV_DIMMABLE_LIGHT = 0x0101, /**< Dimmable light device */ + ZB_HA_DEV_COLOR_DIMMABLE_LIGHT = 0x0102, /**< Color dimmable light device */ + ZB_HA_DEV_ON_OFF_LIGHT_SWITCH = 0x0103, /**< On/off light device */ + ZB_HA_DEV_DIMMER_SWITCH = 0x0104, /**< Dimmer switch device */ + ZB_HA_DEV_COLOR_DIMMER_SWITCH = 0x0105, /**< Color dimmer switch device */ + ZB_HA_DEV_LIGHT_SENSOR = 0x0106, /**< Light sensor device */ + ZB_HA_DEV_OCCUPANCY_SENSOR = 0x0107, /**< Occupancy sensor device */ + + /* Closures devices */ + ZB_HA_DEV_SHADE = 0x0200, /**< Shade device */ + ZB_HA_DEV_SHADE_CONTROLLER = 0x0201, /**< Shade controller device */ + ZB_HA_DEV_WINDOW_COVERING_DEVICE = 0x0202, /**< Window covering device */ + ZB_HA_DEV_WINDOW_COVERING_CONTROLLER = 0x0203, /**< Window covering controller device */ + + /* HVAC devices */ + ZB_HA_DEV_HEATING_COOLING_UNIT = 0x0300, /**< Heating cooling device */ + ZB_HA_DEV_THERMOSTAT = 0x0301, /**< Thermostat device */ + ZB_HA_DEV_TEMPERATURE_SENSOR = 0x0302, /**< Temperature sensor device */ + ZB_HA_DEV_PUMP = 0x0303, /**< Pump device */ + ZB_HA_DEV_PUMP_CONTROLLER = 0x0304, /**< Pump controller device */ + ZB_HA_DEV_PRESSURE_SENSOR = 0x0305, /**< Pressure sensor device */ + ZB_HA_DEV_FLOW_SENSOR = 0x0306, /**< Flow sensor device */ + ZB_HA_DEV_MINI_SPLIT_AC = 0x0307, /**< Mini split device */ + + /* Intruder Alarms system */ + ZB_HA_DEV_IAS_CONTROL_AND_INDICATING_EQUIPMENT = 0x0400, /**< IAS control and indicating equipment device */ + ZB_HA_DEV_IAS_ANCILLARY_CONTROL_EQUIPMENT = 0x0401, /**< IAS ancillary control device */ + ZB_HA_DEV_IAS_ZONE = 0x0402, /**< IAS zone device */ + ZB_HA_DEV_IAS_WARNING_DEVICE = 0x0403, /**< IAS warning device */ +} zb_device_id_e; + #include /** @@ -831,6 +890,15 @@ int zb_get_controller_mac_address(zb_zigbee_h handle, zb_ieee_addr addr64); */ int zb_get_network_info(zb_zigbee_h handle, zb_ieee_addr addr64, zb_nwk_addr *nodeid, zb_nwk_addr *panid, unsigned char *channel, unsigned char *tx_power); +/** + * @} + */ + +/** + * @addtogroup CAPI_NETWORK_ZIGBEE_ZDO_MODULE + * + * @{ + */ /** * @brief Gets all children device list information. @@ -999,8 +1067,6 @@ int zb_end_dev_info_destroy(zb_end_dev_info_h handle); * * @since_tizen 4.0 * - * @remarks This function should be called in zb_end_dev_info_cb() - * * @param[in] handle The handle of a specific end-device * @param[out] addr16 network address of the end-point * @@ -1009,7 +1075,6 @@ int zb_end_dev_info_destroy(zb_end_dev_info_h handle); * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported * - * @see zb_end_dev_info_cb() * @see zb_foreach_end_dev_info() * @see zb_end_dev_info_get_list() */ @@ -1021,8 +1086,6 @@ int zb_end_dev_info_get_network_address(zb_end_dev_info_h handle, * * @since_tizen 4.0 * - * @remarks This function should be called in zb_end_dev_info_cb() - * * @param[in] handle The handle of a specific end-device * @param[out] addr64 ieee address of the end-point * @@ -1031,9 +1094,7 @@ int zb_end_dev_info_get_network_address(zb_end_dev_info_h handle, * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported * - * @see zb_end_dev_info_cb() - * @see zb_foreach_end_dev_info() - * @see zb_end_dev_get_list() + * @see zb_end_dev_info_get_list() */ int zb_end_dev_info_get_ieee_address(zb_end_dev_info_h handle, zb_ieee_addr addr64); @@ -1042,8 +1103,6 @@ int zb_end_dev_info_get_ieee_address(zb_end_dev_info_h handle, zb_ieee_addr addr * * @since_tizen 4.0 * - * @remarks This function should be called in zb_end_dev_info_cb() - * * @param[in] handle The handle of a specific end-device * @param[out] count a number of endpoints of the end-point * @@ -1052,9 +1111,7 @@ int zb_end_dev_info_get_ieee_address(zb_end_dev_info_h handle, zb_ieee_addr addr * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported * - * @see zb_end_dev_info_cb() - * @see zb_foreach_end_dev_info() - * @see zb_end_dev_get_list() + * @see zb_end_dev_info_get_list() */ int zb_end_dev_info_get_num_of_ep(zb_end_dev_info_h handle, unsigned char *count); @@ -1063,8 +1120,7 @@ int zb_end_dev_info_get_num_of_ep(zb_end_dev_info_h handle, unsigned char *count * * @since_tizen 4.0 * - * @remarks This function should be called in zb_end_dev_info_cb(). - * The number of items on the list can be found with zb_end_dev_info_get_num_of_ep(). + * @remarks The number of items on the list can be found with zb_end_dev_info_get_num_of_ep(). * @remarks The @a ep_list should be released using free(). * * @param[in] handle The handle of a specific end-device @@ -1075,8 +1131,6 @@ int zb_end_dev_info_get_num_of_ep(zb_end_dev_info_h handle, unsigned char *count * @retval #ZIGBEE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported * - * @see zb_end_dev_info_cb() - * @see zb_foreach_end_dev_info() * @see zb_end_dev_info_get_list() # @see zb_end_dev_info_get_num_of_ep() */ @@ -1087,8 +1141,6 @@ int zb_end_dev_info_get_ep_list(zb_end_dev_info_h handle, zb_end_point **ep_list * * @since_tizen 4.0 * - * @remarks This function should be called in zb_end_dev_info_cb() - * * @param[in] handle The handle of a specific end-device * @param[out] capability 802.15.4 MAC capability of the end-point * @@ -1099,8 +1151,6 @@ int zb_end_dev_info_get_ep_list(zb_end_dev_info_h handle, zb_end_point **ep_list * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported * - * @see zb_end_dev_info_cb() - * @see zb_foreach_end_dev_info() * @see zb_end_dev_info_get_list() */ int zb_end_dev_info_get_mac_capability(zb_end_dev_info_h handle, @@ -1111,8 +1161,6 @@ int zb_end_dev_info_get_mac_capability(zb_end_dev_info_h handle, * * @since_tizen 4.0 * - * @remarks This function should be called in zb_end_dev_info_cb() - * * @param[in] handle The handle of a specific end-device * @param[out] can_do_it alternative of PAN coordinator of the end-point * @@ -1123,8 +1171,6 @@ int zb_end_dev_info_get_mac_capability(zb_end_dev_info_h handle, * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported * - * @see zb_end_dev_info_cb() - * @see zb_foreach_end_dev_info() * @see zb_end_dev_info_get_list() */ int zb_end_dev_info_get_alternative_pan_coordinator( @@ -1135,8 +1181,6 @@ int zb_end_dev_info_get_alternative_pan_coordinator( * * @since_tizen 4.0 * - * @remarks This function should be called in zb_end_dev_info_cb() - * * @param[in] handle The handle of a specific end-device * @param[in] ep endpoint number * @param[out] deviceid device id of the end-point @@ -1148,8 +1192,6 @@ int zb_end_dev_info_get_alternative_pan_coordinator( * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported * - * @see zb_end_dev_info_cb() - * @see zb_foreach_end_dev_info() * @see zb_end_dev_info_get_list() */ int zb_end_dev_info_get_device_id(zb_end_dev_info_h handle, zb_end_point ep, @@ -1160,8 +1202,6 @@ int zb_end_dev_info_get_device_id(zb_end_dev_info_h handle, zb_end_point ep, * * @since_tizen 4.0 * - * @remarks This function should be called in zb_end_dev_info_cb() - * * @param[in] handle The handle of a specific end-device * @param[in] ep endpoint number * @param[out] profileid profile id of the end-point @@ -1173,8 +1213,6 @@ int zb_end_dev_info_get_device_id(zb_end_dev_info_h handle, zb_end_point ep, * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported * - * @see zb_end_dev_info_cb() - * @see zb_foreach_end_dev_info() * @see zb_end_dev_info_get_list() */ int zb_end_dev_info_get_profile_id(zb_end_dev_info_h handle, zb_end_point ep, @@ -1185,8 +1223,6 @@ int zb_end_dev_info_get_profile_id(zb_end_dev_info_h handle, zb_end_point ep, * * @since_tizen 4.0 * - * @remarks This function should be called in zb_end_dev_info_cb() - * * @param[in] handle The handle of a specific end-device * @param[out] power_src power source type of the end-point * @@ -1197,8 +1233,6 @@ int zb_end_dev_info_get_profile_id(zb_end_dev_info_h handle, zb_end_point ep, * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported * - * @see zb_end_dev_info_cb() - * @see zb_foreach_end_dev_info() * @see zb_end_dev_info_get_list() */ int zb_end_dev_info_get_power_source(zb_end_dev_info_h handle, @@ -1209,8 +1243,6 @@ int zb_end_dev_info_get_power_source(zb_end_dev_info_h handle, * * @since_tizen 4.0 * - * @remarks This function should be called in zb_end_dev_info_cb() - * * @param[in] handle The handle of a specific end-device * @param[out] sec_capability security type of the end-point * @@ -1221,9 +1253,7 @@ int zb_end_dev_info_get_power_source(zb_end_dev_info_h handle, * @retval #ZIGBEE_ERROR_IO_ERROR Unexpected d-bus error * @retval #ZIGBEE_ERROR_NOT_SUPPORTED Not supported * - * @see zb_end_dev_info_cb() - * @see zb_foreach_end_dev_info() - * @see zb_end_dev_get_list() + * @see zb_end_dev_info_get_list() */ int zb_end_dev_info_get_security_capabilty(zb_end_dev_info_h handle, zb_zdp_security_cap_e *sec_capability); diff --git a/include/zigbee_internal.h b/include/zigbee_internal.h index 7cdae4c..df4f11b 100644 --- a/include/zigbee_internal.h +++ b/include/zigbee_internal.h @@ -38,61 +38,6 @@ extern "C" { */ /** - * @brief Devices specified the HA profile. - * - * @since_tizen 4.0 - */ -typedef enum { - /* General devices */ - ZB_HA_ON_OFF_SWITCH = 0x0000, /**< On/off switch device */ - ZB_HA_LEVEL_CONTROL_SWITCH = 0x0001, /**< Level control device */ - ZB_HA_ON_OFF_OUTPUT = 0x0002, /**< On/off output device */ - ZB_HA_LEVEL_CONTROLLABLE_OUTPUT = 0x0003, /**< Controllable output device */ - ZB_HA_SCENE_SELECOTOR = 0x0004, /**< Scene selector device */ - ZB_HA_CONFIGURATION_TOOL = 0x0005, /**< Configuration tool device */ - ZB_HA_REMOTE_CONTROL = 0x0006, /**< Remote control device */ - ZB_HA_COMBINED_INTERFACE = 0x0007, /**< Combined interface device */ - ZB_HA_RANGE_EXTENDER = 0x0008, /**< Range extender device */ - ZB_HA_MAINS_POWER_OUTLET = 0x0009, /**< Main power outlet device */ - ZB_HA_DOOR_LOCK = 0x000A, /**< Door lock device */ - ZB_HA_DOOR_LOCK_CONTROLLER = 0x000B, /**< Door lock controller device */ - ZB_HA_SIMPLE_SENSOR = 0x000C, /**< Simple sensor device */ - ZB_HA_CONSUMPTION_AWARENESS_DEVICE = 0x000D, /**< Consumption awareness device */ - ZB_HA_HOME_GATEWAY = 0x0050, /**< Home gateway device */ - ZB_HA_SMART_PLUG = 0x0051, /**< Smart plug device */ - ZB_HA_WHITE_GOODS = 0x0052, /**< White goods device */ - ZB_HA_METER_INTERFACE = 0x0053, /**< Meter interface device */ - /* Lighting devices */ - ZB_HA_ON_OFF_LIGHT = 0x0100, /**< On/off light device */ - ZB_HA_DIMMABLE_LIGHT = 0x0101, /**< Dimmable light device */ - ZB_HA_COLOR_DIMMABLE_LIGHT = 0x0102, /**< Color dimmable light device */ - ZB_HA_ON_OFF_LIGHT_SWITCH = 0x0103, /**< On/off light device */ - ZB_HA_DIMMER_SWITCH = 0x0104, /**< Dimmer switch device */ - ZB_HA_COLOR_DIMMER_SWITCH = 0x0105, /**< Color dimmer switch device */ - ZB_HA_LIGHT_SENSOR = 0x0106, /**< Light sensor device */ - ZB_HA_OCUPANCY_SENSOR = 0x0107, /**< Ocupancy sensor device */ - /* Closures devices */ - ZB_HA_SHADE = 0x0200, /**< Shade device */ - ZB_HA_SHADE_CONTROLLER = 0x0201, /**< Shade controller device */ - ZB_HA_WINDOW_COVERING_DEVICE = 0x0202, /**< Window covering device */ - ZB_HA_WINDOW_COVERING_CONTROLLER = 0x0203, /**< Window covering controller device */ - /* HVAC devices */ - ZB_HA_HEATING_COOLLING_UNIT = 0x0300, /**< Heating coolling device */ - ZB_HA_THERMOSTAT = 0x0301, /**< Thermostat device */ - ZB_HA_TEMPERATURE_SENSOR = 0x0302, /**< Temperature sensor device */ - ZB_HA_PUMP = 0x0303, /**< Pump device */ - ZB_HA_PUMP_CONTROLLER = 0x0304, /**< Pump controller device */ - ZB_HA_PRESSURE_SENSOR = 0x0305, /**< Pressure sensor device */ - ZB_HA_FLOW_SENSOR = 0x0306, /**< Flow sensor device */ - ZB_HA_MINI_SPLIT_AC = 0x0307, /**< Mini split device */ - /* Intruder Alarms system */ - ZB_HA_IAS_CONTROL_AND_INDICATING_EQUIPMENT = 0x0400, /**< IAS control and indicating equipment device */ - ZB_HA_IAS_ANCILLARY_CONTROL_EQUIPMENT = 0x0401, /**< IAS ancillary control device */ - ZB_HA_IAS_ZONE = 0x0402, /**< IAS zone device */ - ZB_HA_IAS_WARNIGN_DEVICE = 0x0403, /**< IAS warning device */ -} ha_device_id_e; - -/** * @internal * @brief Called after custom APS send command. * diff --git a/include/zigbee_private.h b/include/zigbee_private.h index 5741a91..b2916e8 100644 --- a/include/zigbee_private.h +++ b/include/zigbee_private.h @@ -31,6 +31,7 @@ extern "C" { */ /** + * @internal * @ingroup CAPI_NETWORK_ZIGBEE_MODULE * @brief The events for zb_event_cb(). * @@ -55,6 +56,7 @@ typedef enum { } zb_event_ext_e; /** + * @internal * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_REPORTING_CONFIG_RESPONSE_RECORD_MODULE * @brief Sets status to a reporting configuration response record. * @details If the attribute is not implemented on the sender or receiver of the command, @@ -94,6 +96,7 @@ int zb_report_config_response_record_set_status( zb_zcl_status_e status); /** + * @internal * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_REPORTING_CONFIG_RESPONSE_RECORD_MODULE * @brief Sets the direction to a reporting configuration response record. * @details The direction field specifies whether values of the attribute are reported @@ -134,6 +137,7 @@ int zb_report_config_response_record_set_dir( zb_zcl_fc_direction_e dir); /** + * @internal * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_REPORTING_CONFIG_RESPONSE_RECORD_MODULE * @brief Sets the attribute identifier to a reporting configuration response record. * @details The attribute identifier field is 16 bits in length and shall contain the @@ -164,6 +168,25 @@ int zb_report_config_response_record_set_id( zb_attribute_id id); /** + * @internal + * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE + * @brief Uses this value as the return value to stop foreach function. + * + * @since_tizen 4.0 + */ +#define ZIGBEE_FUNC_STOP false + +/** + * @internal + * @ingroup CAPI_NETWORK_ZIGBEE_ZCL_MODULE + * @brief Uses this value as the return value to continue foreach function. + * + * @since_tizen 4.0 + */ +#define ZIGBEE_FUNC_CONTINUE true + +/** + * @internal * @brief Called after getting end-device information. * * @since_tizen 4.0 @@ -186,6 +209,7 @@ int zb_report_config_response_record_set_id( typedef bool (*zb_end_dev_info_cb)(int index, zb_end_dev_info_h child, void *user_data); /** + * @internal * @brief Calls a function for each children end-point of parent. * * @since_tizen 4.0 @@ -209,6 +233,7 @@ int zb_foreach_end_dev_info(zb_end_dev_info_h *list, /** + * @internal * @brief Gets the records of the received global command. * @since_tizen 4.0 * @@ -233,6 +258,7 @@ int zb_ev_get_global_attr_report_records(zb_event_data_h ev, zb_zcl_attr_report_h* records, unsigned char *count); /** + * @internal * @brief Gets the alarm count. * @since_tizen 4.0 *