nRF5 SDK for Thread and Zigbee v1.0.0
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Prepayment cluster attributes

Data Structures

struct  zb_zcl_prepayment_attrs_s
 Prepayment cluster Mandatory attributes. More...
 

Macros

#define ZB_ZCL_DECLARE_PREPAYMENT_ATTR_LIST(attr_list, attrs)   ZB_ZCL_DECLARE_PREPAYMENT_ATTRIB_LIST(attr_list, &attrs.payment_control_configuration)
 

Typedefs

typedef enum
zb_zcl_prepayment_attr_sets_e 
zb_zcl_prepayment_attr_sets_t
 
typedef enum
zb_zcl_prepayment_prepayment_information_attr_set_e 
zb_zcl_prepayment_prepayment_information_attr_set_t
 
typedef struct
zb_zcl_prepayment_attrs_s 
zb_zcl_prepayment_attrs_t
 Prepayment cluster Mandatory attributes.
 
typedef enum
zb_zcl_prepayment_payment_control_configuration_attr_e 
zb_zcl_prepayment_payment_control_configuration_attr_t
 
typedef enum
zb_zcl_prepayment_credit_status_attr_e 
zb_zcl_prepayment_credit_status_attr_t
 
typedef enum
zb_zcl_prepayment_top_up_attr_set_e 
zb_zcl_prepayment_top_up_attr_set_t
 
typedef enum
zb_zcl_prepayment_debt_attr_set_e 
zb_zcl_prepayment_debt_attr_set_t
 
typedef enum
zb_zcl_prepayment_debt_recovery_method_e 
zb_zcl_prepayment_debt_recovery_method_t
 
typedef enum
zb_zcl_prepayment_recovery_frequency_e 
zb_zcl_prepayment_recovery_frequency_t
 
typedef enum
zb_zcl_prepayment_alarms_attr_set_e 
zb_zcl_prepayment_alarms_attr_set_t
 
typedef enum
zb_zcl_prepayment_prepayment_alarm_status_indicators_e 
zb_zcl_prepayment_prepayment_alarm_status_indicators_t
 
typedef enum
zb_zcl_prepayment_prepay_generic_alarm_group_e 
zb_zcl_prepayment_prepay_generic_alarm_group_t
 
typedef enum
zb_zcl_prepayment_prepay_switch_alarm_group_e 
zb_zcl_prepayment_prepay_switch_alarm_group_t
 
typedef enum
zb_zcl_prepayment_prepay_event_alarm_group_e 
zb_zcl_prepayment_prepay_event_alarm_group_t
 
typedef enum
zb_zcl_prepayment_historical_cost_consumption_information_set_e 
zb_zcl_prepayment_historical_cost_consumption_information_set_t
 
typedef enum
zb_zcl_prepayment_currency_scaling_factor_e 
zb_zcl_prepayment_currency_scaling_factor_t
 

Enumerations

enum  zb_zcl_prepayment_attr_sets_e {
  ZB_ZCL_PREPAYMENT_SET_PREPAYMENT_INFORMATION = 0x00, ZB_ZCL_PREPAYMENT_SET_TOP_UP, ZB_ZCL_PREPAYMENT_SET_DEBT, ZB_ZCL_PREPAYMENT_SET_ALARM = 0x04,
  ZB_ZCL_PREPAYMENT_SET_HISTORICAL_COST_CONSUMPTION_INFORMATION
}
 
enum  zb_zcl_prepayment_prepayment_information_attr_set_e {
  ZB_ZCL_ATTR_PREPAYMENT_PAYMENT_CONTROL_CONFIGURATION = 0x0000, ZB_ZCL_ATTR_PREPAYMENT_CREDIT_REMAINING, ZB_ZCL_ATTR_PREPAYMENT_EMERGENCY_CREDIT_REMAINING, ZB_ZCL_ATTR_PREPAYMENT_CREDIT_STATUS,
  ZB_ZCL_ATTR_PREPAYMENT_CREDIT_REMAINING_TIMESTAMP, ZB_ZCL_ATTR_PREPAYMENT_ACCUMULATED_DEBT, ZB_ZCL_ATTR_PREPAYMENT_OVERALL_DEBT_CAP, ZB_ZCL_ATTR_PREPAYMENT_EMERGENCY_CREDIT_LIMIT = 0x0010,
  ZB_ZCL_ATTR_PREPAYMENT_EMERGENCY_CREDIT_THRESHOLD, ZB_ZCL_ATTR_PREPAYMENT_TOTAL_CREDIT_ADDED = 0x0020, ZB_ZCL_ATTR_PREPAYMENT_MAX_CREDIT_LIMIT, ZB_ZCL_ATTR_PREPAYMENT_MAX_CREDIT_PER_TOP_UP,
  ZB_ZCL_ATTR_PREPAYMENT_FRIENDLY_CREDIT_WARNING = 0x0030, ZB_ZCL_ATTR_PREPAYMENT_LOW_CREDIT_WARNING, ZB_ZCL_ATTR_PREPAYMENT_IHD_LOW_CREDIT_WARNING, ZB_ZCL_ATTR_PREPAYMENT_INTERRUPT_SUSPEND_TIME,
  ZB_ZCL_ATTR_PREPAYMENT_REMAINING_FRIENDLY_CREDIT_TIMES, ZB_ZCL_ATTR_PREPAYMENT_NEXT_FRIENDLY_CREDIT_PERIOD, ZB_ZCL_ATTR_PREPAYMENT_CUT_OFF_VALUE = 0x0040, ZB_ZCL_ATTR_PREPAYMENT_TOKEN_CARRIER_ID = 0x0080
}
 
enum  zb_zcl_prepayment_payment_control_configuration_attr_e {
  PREPAYMENT_DISCONNECTION_ENABLED = 1 << 0, PREPAYMENT_PREPAYMENT_ENABLED = 1 << 1, PREPAYMENT_CREDIT_MANAGEMENT_ENABLED = 1 << 2, PREPAYMENT_CREDIT_DISPLAY_ENABLED = 1 << 4,
  PREPAYMENT_ACCOUNT_BASE = 1 << 5, PREPAYMENT_CONTACTOR_FITTED = 1 << 7, PREPAYMENT_STANDING_CHARGE_CONFIGURATION = 1 << 8, PREPAYMENT_EMERGENCY_STANDING_CHARGE_CONFIGURATION = 1 << 9,
  PREPAYMENT_DEBT_CONFIGURATION = 1 << 10, PREPAYMENT_EMERGENCY_DEBT_CONFIGURATION = 1 << 11
}
 
enum  zb_zcl_prepayment_credit_status_attr_e {
  ZB_ZCL_PREPAYMENT_CREDIT_STATUS_CREDIT_OK = 1 << 0, ZB_ZCL_PREPAYMENT_CREDIT_STATUS_LOW_CREDIT = 1 << 1, ZB_ZCL_PREPAYMENT_CREDIT_STATUS_EMERGENCY_CREDIT_ENABLED = 1 << 2, ZB_ZCL_PREPAYMENT_CREDIT_STATUS_EMERGENCY_CREDIT_AVAILABLE = 1 << 3,
  ZB_ZCL_PREPAYMENT_CREDIT_STATUS_EMERGENCY_CREDIT_SELECTED = 1 << 4, ZB_ZCL_PREPAYMENT_CREDIT_STATUS_EMERGENCY_CREDIT_IN_USE = 1 << 5, ZB_ZCL_PREPAYMENT_CREDIT_STATUS_CREDIT_EXHAUSTED = 1 << 6
}
 
enum  zb_zcl_prepayment_top_up_attr_set_e {
  ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_DATE_1 = 0x0100, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_AMOUNT_1, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_ORIGINATING_DEVICE_1, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_CODE_1,
  ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_DATE_2 = 0x0110, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_AMOUNT_2, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_ORIGINATING_DEVICE_2, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_CODE_2,
  ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_DATE_3 = 0x0120, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_AMOUNT_3, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_ORIGINATING_DEVICE_3, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_CODE_3,
  ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_DATE_4 = 0x0130, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_AMOUNT_4, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_ORIGINATING_DEVICE_4, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_CODE_4,
  ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_DATE_5 = 0x0140, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_AMOUNT_5, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_ORIGINATING_DEVICE_5, ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_CODE_5
}
 
enum  zb_zcl_prepayment_debt_attr_set_e {
  ZB_ZCL_ATTR_PREPAYMENT_DEBT_LABEL_1 = 0x0210, ZB_ZCL_ATTR_PREPAYMENT_DEBT_AMOUNT_1, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_METHOD_1, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_START_TIME_1,
  ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_COLLECTION_TIME_1, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_FREQUENCY_1 = 0x0216, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_AMOUNT_1, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_TOP_UP_PERCENTAGE_1 = 0x0219,
  ZB_ZCL_ATTR_PREPAYMENT_DEBT_LABEL_2 = 0x0220, ZB_ZCL_ATTR_PREPAYMENT_DEBT_AMOUNT_2, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_METHOD_2, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_START_TIME_2,
  ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_COLLECTION_TIME_2, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_FREQUENCY_2 = 0x0226, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_AMOUNT_2, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_TOP_UP_PERCENTAGE_2 = 0x0229,
  ZB_ZCL_ATTR_PREPAYMENT_DEBT_LABEL_3 = 0x0230, ZB_ZCL_ATTR_PREPAYMENT_DEBT_AMOUNT_3, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_METHOD_3, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_START_TIME_3,
  ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_COLLECTION_TIME_3, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_FREQUENCY_3 =0x0236, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_AMOUNT_3, ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_TOP_UP_PERCENTAGE_3 = 0x0239
}
 
enum  zb_zcl_prepayment_debt_recovery_method_e { ZB_ZCL_PREPAYMENT_TIME_BASED = 0x00, ZB_ZCL_PREPAYMENT_PERCENTAGE_BASED, ZB_ZCL_PREPAYMENT_CATCH_UP_BASED }
 
enum  zb_zcl_prepayment_recovery_frequency_e {
  ZB_ZCL_PREPAYMENT_PER_HOUR = 0x00, ZB_ZCL_PREPAYMENT_PER_DAY, ZB_ZCL_PREPAYMENT_PER_WEEK, ZB_ZCL_PREPAYMENT_PER_MONTH,
  ZB_ZCL_PREPAYMENT_PER_QUARTER
}
 
enum  zb_zcl_prepayment_alarms_attr_set_e { ZB_ZCL_ATTR_PREPAYMENT_PREPAYMENT_ALARM_STATUS = 0x0400, ZB_ZCL_ATTR_PREPAYMENT_PREPAY_GENERIC_ALARM_MASK, ZB_ZCL_ATTR_PREPAYMENT_PREPAY_SWITCH_ALARM_MASK, ZB_ZCL_ATTR_PREPAYMENT_PREPAY_EVENT_ALARM_MASK }
 
enum  zb_zcl_prepayment_prepayment_alarm_status_indicators_e {
  ZB_ZCL_PREPAYMENT_ALARM_LOW_CREDIT_WARNING = 1 << 0, ZB_ZCL_PREPAYMENT_ALARM_TOP_UP_CODE_ERROR = 1 << 1, ZB_ZCL_PREPAYMENT_ALARM_TOP_UP_CODE_ALREADY_USED = 1 << 2, ZB_ZCL_PREPAYMENT_ALARM_TOP_UP_CODE_INVALID = 1 << 3,
  ZB_ZCL_PREPAYMENT_ALARM_FRIENDLY_CREDIT_IN_USE = 1 << 4, ZB_ZCL_PREPAYMENT_ALARM_FRIENDLY_CREDIT_PERIOD_END_WARNING = 1 << 5, ZB_ZCL_PREPAYMENT_ALARM_EC_AVAILABLE = 1 << 6, ZB_ZCL_PREPAYMENT_ALARM_UNAUTHORISED_ENERGY_USE = 1 << 7,
  ZB_ZCL_PREPAYMENT_ALARM_DISCONNECTED_SUPPLY_DUE_TO_CREDIT = 1 << 8, ZB_ZCL_PREPAYMENT_ALARM_DISCONNECTED_SUPPLY_DUE_TO_TAMPER = 1 << 9, ZB_ZCL_PREPAYMENT_ALARM_DISCONNECTED_SUPPLY_DUE_TO_HES = 1 << 10, ZB_ZCL_PREPAYMENT_ALARM_PHYSICAL_ATTACK = 1 << 11,
  ZB_ZCL_PREPAYMENT_ALARM_ELECTRONIC_ATTACK = 1 << 12, ZB_ZCL_PREPAYMENT_ALARM_MANUFACTURE_ALARM_CODE_A = 1 << 13, ZB_ZCL_PREPAYMENT_ALARM_MANUFACTURE_ALARM_CODE_B = 1 << 14
}
 
enum  zb_zcl_prepayment_prepay_generic_alarm_group_e {
  ZB_ZCL_PREPAYMENT_GROUP_LOW_CREDIT = 0x00, ZB_ZCL_PREPAYMENT_GROUP_NO_CREDIT, ZB_ZCL_PREPAYMENT_GROUP_CREDIT_EXHAUSTED, ZB_ZCL_PREPAYMENT_GROUP_EMERGENCY_CREDIT_ENABLED,
  ZB_ZCL_PREPAYMENT_GROUP_EMERGENCY_CREDIT_EXHAUSTED, ZB_ZCL_PREPAYMENT_GROUP_IHD_LOW_CREDIT_WARNING, ZB_ZCL_PREPAYMENT_GROUP_EVENT_LOG_CLEARED
}
 
enum  zb_zcl_prepayment_prepay_switch_alarm_group_e {
  ZB_ZCL_PREPAYMENT_GROUP_SUPPLY_ON = 0x10, ZB_ZCL_PREPAYMENT_GROUP_SUPPLY_ARM, ZB_ZCL_PREPAYMENT_GROUP_SUPPLY_OFF, ZB_ZCL_PREPAYMENT_GROUP_DISCONNECTION_FAILURE,
  ZB_ZCL_PREPAYMENT_GROUP_DISCONNECTION_TAMPER_DETECTED, ZB_ZCL_PREPAYMENT_GROUP_DISCONNECTED_DUE_TO_CUT_OFF_VALUE, ZB_ZCL_PREPAYMENT_GROUP_REMOTE_DISCONNECTED
}
 
enum  zb_zcl_prepayment_prepay_event_alarm_group_e {
  ZB_ZCL_PREPAYMENT_GROUP_PHYSICAL_ATTACK_ON_PREPAY_METER = 0x20, ZB_ZCL_PREPAYMENT_GROUP_ELECTRONIC_ATTACK_ON_PREPAY_METER, ZB_ZCL_PREPAYMENT_GROUP_DISCOUNT_APPLIED, ZB_ZCL_PREPAYMENT_GROUP_CREDIT_ADJUSTMENT,
  ZB_ZCL_PREPAYMENT_GROUP_CREDIT_ADJUSTMENT_FAIL, ZB_ZCL_PREPAYMENT_GROUP_DEBT_ADJUSTMENT, ZB_ZCL_PREPAYMENT_GROUP_DEBT_ADJUSTMENT_FAIL, ZB_ZCL_PREPAYMENT_GROUP_MODE_CHANGE,
  ZB_ZCL_PREPAYMENT_GROUP_TOP_UP_CODE_ERROR, ZB_ZCL_PREPAYMENT_GROUP_TOP_UP_ALREADY_USED, ZB_ZCL_PREPAYMENT_GROUP_TOP_UP_CODE_INVALID, ZB_ZCL_PREPAYMENT_GROUP_FRIENDLY_CREDIT_IN_USE,
  ZB_ZCL_PREPAYMENT_GROUP_FRIENDLY_CREDIT_PERIOD_END_WARNING, ZB_ZCL_PREPAYMENT_GROUP_FRIENDLY_CREDIT_PERIOD_END, ZB_ZCL_PREPAYMENT_GROUP_ERROR_REG_CLEAR = 0x30, ZB_ZCL_PREPAYMENT_GROUP_ALARM_REG_CLEAR,
  ZB_ZCL_PREPAYMENT_GROUP_PREPAY_CLUSTER_NOT_FOUND, ZB_ZCL_PREPAYMENT_GROUP_MODE_CREDIT_2_PREPAY = 0x41, ZB_ZCL_PREPAYMENT_GROUP_MODE_PREPAY_2_CREDIT, ZB_ZCL_PREPAYMENT_GROUP_MODE_DEFAULT
}
 
enum  zb_zcl_prepayment_historical_cost_consumption_information_set_e {
  ZB_ZCL_ATTR_PREPAYMENT_HISTORICAL_COST_CONSUMPTION_FORMATING = 0x0500, ZB_ZCL_ATTR_PREPAYMENT_CONSUMPTION_UNIT_OF_MEASUREMENT, ZB_ZCL_ATTR_PREPAYMENT_CURRENCY_SCALING_FACTOR, ZB_ZCL_ATTR_PREPAYMENT_CURRENCY,
  ZB_ZCL_ATTR_PREPAYMENT_CURRENT_DAY_COST_CONSUMPTION_DELIVERED = 0x051C, ZB_ZCL_ATTR_PREPAYMENT_CURRENT_DAY_COST_CONSUMPTION_RECEIVED, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_DELIVERED, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_RECEIVED,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_DELIVERED_2, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_RECEIVED_2, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_DELIVERED_3, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_RECEIVED_3,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_DELIVERED_4, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_RECEIVED_4, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_DELIVERED_5, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_RECEIVED_5,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_DELIVERED_6, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_RECEIVED_6, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_DELIVERED_7, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_RECEIVED_7,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_DELIVERED_8, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_RECEIVED_8, ZB_ZCL_ATTR_PREPAYMENT_CURRENT_WEEK_COST_CONSUMPTION_DELIVERED = 0x0530, ZB_ZCL_ATTR_PREPAYMENT_CURRENT_WEEK_COST_CONSUMPTION_RECEIVED,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_DELIVERED, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_RECEIVED, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_DELIVERED_2, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_RECEIVED_2,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_DELIVERED_3, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_RECEIVED_3, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_DELIVERED_4, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_RECEIVED_4,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_DELIVERED_5, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_RECEIVED_5, ZB_ZCL_ATTR_PREPAYMENT_CURRENT_MONTH_COST_CONSUMPTION_DELIVERED = 0x0540, ZB_ZCL_ATTR_PREPAYMENT_CURRENT_MONTH_COST_CONSUMPTION_RECEIVED,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_2, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_2,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_3, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_3, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_4, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_4,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_5, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_5, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_6, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_6,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_7, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_7, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_8, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_8,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_9, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_9, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_10, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_10,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_11, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_11, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_12, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_12,
  ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED_13, ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED_13, ZB_ZCL_ATTR_PREPAYMENT_HISTORICAL_FREEZE_TIME
}
 
enum  zb_zcl_prepayment_currency_scaling_factor_e {
  ZB_ZCL_PREPAYMENT_SCALE_DOT_000001 = 0x00, ZB_ZCL_PREPAYMENT_SCALE_DOT_00001, ZB_ZCL_PREPAYMENT_SCALE_DOT_0001, ZB_ZCL_PREPAYMENT_SCALE_DOT_001,
  ZB_ZCL_PREPAYMENT_SCALE_DOT_01, ZB_ZCL_PREPAYMENT_SCALE_DOT_1, ZB_ZCL_PREPAYMENT_SCALE_1, ZB_ZCL_PREPAYMENT_SCALE_10,
  ZB_ZCL_PREPAYMENT_SCALE_100, ZB_ZCL_PREPAYMENT_SCALE_1000, ZB_ZCL_PREPAYMENT_SCALE_10000, ZB_ZCL_PREPAYMENT_SCALE_100000,
  ZB_ZCL_PREPAYMENT_SCALE_1000000
}
 

Detailed Description

Macro Definition Documentation

#define ZB_ZCL_DECLARE_PREPAYMENT_ATTR_LIST (   attr_list,
  attrs 
)    ZB_ZCL_DECLARE_PREPAYMENT_ATTRIB_LIST(attr_list, &attrs.payment_control_configuration)

Declare attribute list for Prepayment cluster

Parameters
[in]attr_list- attribute list variable name
[in]attrs- pointer to zb_zcl_prepayment_attrs_s structure

Typedef Documentation

The Alarms Attribute Set provides a means to control which prepayment alarms may be generated from the meter.

See also
SE spec, subclause 7.2.2.5

Prepayment Server Attribute Sets

See also
SE spec, subclause 7.2.2

The Credit Status attribute represents the current status of credit within the Metering Device.

See also
SE spec, Table D-131

CurrencyScalingFactor Enumerations

See also
SE spec, Table D-144

Debt Attribute Set provides access to information on debt held on a Prepayment meter.

See also
SE spec, subclause 7.2.2.3

Debt Recovery Method Enumerations

See also
SE spec, Table D-135

Historical Cost Consumption Information Set

See also
SE spec, subclause 7.2.2.6

The PaymentControlConfiguration attribute represents the payment mechanisms currently enabled within the Metering Device.

See also
SE spec, Table D-130

PrepayEventAlarmGroup

See also
SE spec, Table D-142

PrepayGenericAlarmGroup

See also
SE spec, Table D-140

PrepaySwitchAlarmGroup

See also
SE spec, Table D-141

Prepayment Alarm Status Indicators

See also
SE spec, Table D-138

The Prepayment Information Attribute Set provides access to the standard information relating to a Prepayment meter.

See also
SE spec, subclause 7.2.2.1

Recovery Frequency Field Enumerations

See also
SE spec, Table D-136

The Top-up Attribute Set provides access to previous successful credit top-ups on a prepayment meter. #1 is the most recent, based on time.

See also
SE spec, subclause 7.2.2.2

Enumeration Type Documentation

The Alarms Attribute Set provides a means to control which prepayment alarms may be generated from the meter.

See also
SE spec, subclause 7.2.2.5
Enumerator
ZB_ZCL_ATTR_PREPAYMENT_PREPAYMENT_ALARM_STATUS 

The PrepaymentAlarmStatus attribute provides indicators reflecting the current error conditions found by the prepayment metering device.

ZB_ZCL_ATTR_PREPAYMENT_PREPAY_GENERIC_ALARM_MASK 

The Alarm Mask attributes of the Alarms Attribute Set specify whether each of the alarms listed in the corresponding alarm group in Table D-139 through Table D-142 is enabled.

Prepayment Server Attribute Sets

See also
SE spec, subclause 7.2.2
Enumerator
ZB_ZCL_PREPAYMENT_SET_PREPAYMENT_INFORMATION 

The following set of attributes provides access to the standard information relating to a Prepayment meter.

ZB_ZCL_PREPAYMENT_SET_TOP_UP 

The following set of attributes provides access to previous successful credit top-ups on a prepayment meter. #1 is the most recent, based on time.

ZB_ZCL_PREPAYMENT_SET_DEBT 

This set of attributes provides access to information on debt held on a Prepayment meter.

ZB_ZCL_PREPAYMENT_SET_ALARM 

The following set of attributes provides a means to control which prepayment alarms may be generated from the meter.

ZB_ZCL_PREPAYMENT_SET_HISTORICAL_COST_CONSUMPTION_INFORMATION 

Historical Cost Consumption Information Attribute Set

The Credit Status attribute represents the current status of credit within the Metering Device.

See also
SE spec, Table D-131
Enumerator
ZB_ZCL_PREPAYMENT_CREDIT_STATUS_CREDIT_OK 

Credit Ok

ZB_ZCL_PREPAYMENT_CREDIT_STATUS_LOW_CREDIT 

Low Credit

ZB_ZCL_PREPAYMENT_CREDIT_STATUS_EMERGENCY_CREDIT_ENABLED 

Emergency Credit Enabled

ZB_ZCL_PREPAYMENT_CREDIT_STATUS_EMERGENCY_CREDIT_AVAILABLE 

Emergency Credit Available

ZB_ZCL_PREPAYMENT_CREDIT_STATUS_EMERGENCY_CREDIT_SELECTED 

Emergency Credit Selected

ZB_ZCL_PREPAYMENT_CREDIT_STATUS_EMERGENCY_CREDIT_IN_USE 

Emergency Credit In Use

ZB_ZCL_PREPAYMENT_CREDIT_STATUS_CREDIT_EXHAUSTED 

Credit Exhausted

CurrencyScalingFactor Enumerations

See also
SE spec, Table D-144

Debt Attribute Set provides access to information on debt held on a Prepayment meter.

See also
SE spec, subclause 7.2.2.3
Enumerator
ZB_ZCL_ATTR_PREPAYMENT_DEBT_LABEL_1 

The DebtLabel::n attribute provides a method for utilities to assign a name to a particular type of debt. The DebtLabel::n attribute is a ZCL Octet String field capable of storing a 12 character string (the first Octet indicates length) encoded in the UTF-8 format.

ZB_ZCL_ATTR_PREPAYMENT_DEBT_AMOUNT_1 

An unsigned 32-bit field to denote the amount of Debt remaining on the Metering Device. This parameter shall be measured in base unit of Currency with the decimal point located as indicated by the Trailing Digits field, as defined in the Price Cluster.

ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_METHOD_1 

An enumerated attribute denoting the debt recovery method used for this debt type

ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_START_TIME_1 

A UTC Time field to denote the time at which the debt collection should start. This applies to all debt recovery methods.

ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_COLLECTION_TIME_1 

An unsigned 16-bit field denoting the time of day when the debt collection takes place.

ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_FREQUENCY_1 

The DebtRecoveryFrequency::N attribute represents the period over which each DebtRecoveryAmount::N is recovered.

ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_AMOUNT_1 

The DebtRecoveryAmount::N attribute represents the amount of Debt recovered each period specified by DebtRecoveryFrequency::N, measured in base unit of Currency with the decimal point located as indicated by the Trailing Digits field, as defined in the Price Cluster.

ZB_ZCL_ATTR_PREPAYMENT_DEBT_RECOVERY_TOP_UP_PERCENTAGE_1 

An unsigned 16-bit field used in Percentage based recovery to denote the percentage from a top- up amount to be deducted from the debt.

Debt Recovery Method Enumerations

See also
SE spec, Table D-135
Enumerator
ZB_ZCL_PREPAYMENT_TIME_BASED 

Time based

ZB_ZCL_PREPAYMENT_PERCENTAGE_BASED 

Percentage based

ZB_ZCL_PREPAYMENT_CATCH_UP_BASED 

Catch UP based

Historical Cost Consumption Information Set

See also
SE spec, subclause 7.2.2.6
Enumerator
ZB_ZCL_ATTR_PREPAYMENT_HISTORICAL_COST_CONSUMPTION_FORMATING 

HistoricalCostConsumptionFormatting provides a method to properly decipher the decimal point location for the values found in the Historical Cost Consumption Set of attributes

ZB_ZCL_ATTR_PREPAYMENT_CONSUMPTION_UNIT_OF_MEASUREMENT 

ConsumptionUnitOfMeasurement provides a label for the Energy, Gas, or Water being measured by the metering device.

ZB_ZCL_ATTR_PREPAYMENT_CURRENCY_SCALING_FACTOR 

CurrencyScalingFactor provides a scaling factor for the Currency attribute for the Energy, Gas, or Water being measured by the metering device.

ZB_ZCL_ATTR_PREPAYMENT_CURRENCY 

The Currency attribute provides the currency for the Energy, Gas, or Water being measured by the prepayment device.

ZB_ZCL_ATTR_PREPAYMENT_CURRENT_DAY_COST_CONSUMPTION_DELIVERED 

It represents the summed value of Energy, Gas, or Water delivered to the premises since the HFT.

ZB_ZCL_ATTR_PREPAYMENT_CURRENT_DAY_COST_CONSUMPTION_RECEIVED 

represents the summed value of Energy, Gas, or Water received from the premises since the HFT.

ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_DELIVERED 

PreviousDayNCostConsumptionDelivered represents the summed value of Energy, Gas, or Water delivered to the premises within the previous 24 hour period starting at the HFT.

ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_DAY_COST_CONSUMPTION_RECEIVED 

PreviousDayNCostConsumptionReceived represents the summed value of Energy, Gas, or Water received from the premises within the previous 24 hour period starting at the HFT.

ZB_ZCL_ATTR_PREPAYMENT_CURRENT_WEEK_COST_CONSUMPTION_DELIVERED 

CurrentWeekCostConsumptionDelivered represents the summed value of Energy, Gas, or Water delivered to the premises since the HFT on Monday to the last HFT read.

ZB_ZCL_ATTR_PREPAYMENT_CURRENT_WEEK_COST_CONSUMPTION_RECEIVED 

CurrentWeekCostConsumptionReceived represents the summed value of Energy, Gas, or Water received from the premises since the HFT on Monday to the last HFT read.

ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_DELIVERED 

PreviousWeekNCostConsumptionDelivered represents the summed value of Energy, Gas, or Water delivered to the premises within the previous week period starting at the HFT on the Monday to the Sunday.

ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_WEEK_COST_CONSUMPTION_RECEIVED 

PreviousWeekNCostConsumptionReceived represents the summed value of Energy, Gas, or Water received from the premises within the previous week period starting at the HFT on the Monday to the Sunday

ZB_ZCL_ATTR_PREPAYMENT_CURRENT_MONTH_COST_CONSUMPTION_DELIVERED 

CurrentMonthCostConsumptionDelivered represents the summed value of Energy, Gas, or Water delivered to the premises since the HFT on the 1 st of the month to the last HFT read.

ZB_ZCL_ATTR_PREPAYMENT_CURRENT_MONTH_COST_CONSUMPTION_RECEIVED 

CurrentMonthCostConsumptionReceived represents the summed value of Energy, Gas, or Water received from the premises since the HFT on the 1 st of the month to the last HFT read.

ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_DELIVERED 

PreviousMonthNCostConsumptionDelivered represents the summed value of Energy, Gas, or Water delivered to the premises within the previous Month period starting at the HFT on the 1 st of the month to the last day of the month.

ZB_ZCL_ATTR_PREPAYMENT_PREVIOUS_MONTH_COST_CONSUMPTION_RECEIVED 

PreviousMonthNCostConsumptionReceived represents the summed value of Energy, Gas, or Water received from the premises within the previous month period starting at the HFT on the 1 st of the month to the last day of the month.

ZB_ZCL_ATTR_PREPAYMENT_HISTORICAL_FREEZE_TIME 

HistoricalFreezeTime represents the time of day, in Local Time, when Historical Cost Consumption attributes are captured.

The PaymentControlConfiguration attribute represents the payment mechanisms currently enabled within the Metering Device.

See also
SE spec, Table D-130
Enumerator
PREPAYMENT_DISCONNECTION_ENABLED 

Indicates whether the metering device is to disconnect the energy supply on expiry of available credit.

PREPAYMENT_PREPAYMENT_ENABLED 

Indicates if the meter is a ‘prepayment’ meter; if this value is 0, the meter is considered to be a ‘credit’ meter.

PREPAYMENT_CREDIT_MANAGEMENT_ENABLED 

Indicates whether the metering device should manage accounting functionality according to available tariff information.

PREPAYMENT_CREDIT_DISPLAY_ENABLED 

Indicates whether the metering device should display the credit status.

PREPAYMENT_ACCOUNT_BASE 

Indicates whether the metering device is running in Monetary (0) or Unit based (1) units.

PREPAYMENT_CONTACTOR_FITTED 

Indicates whether the metering device is fitted with a Contactor i.e. is capable if disconnecting the energy supply.

PREPAYMENT_STANDING_CHARGE_CONFIGURATION 

Indicates whether the standing charge collection is halted when the prepaid credit is exhausted.

PREPAYMENT_EMERGENCY_STANDING_CHARGE_CONFIGURATION 

Indicates whether the standing charge collection is halted when the device is in Emergency Credit mode.

PREPAYMENT_DEBT_CONFIGURATION 

Indicates whether the debt collection is halted when the prepaid credit is exhausted.

PREPAYMENT_EMERGENCY_DEBT_CONFIGURATION 

Indicates whether the debt is collected when the device is in Emergency Credit mode.

PrepayEventAlarmGroup

See also
SE spec, Table D-142

PrepayGenericAlarmGroup

See also
SE spec, Table D-140

PrepaySwitchAlarmGroup

See also
SE spec, Table D-141

Prepayment Alarm Status Indicators

See also
SE spec, Table D-138
Enumerator
ZB_ZCL_PREPAYMENT_ALARM_LOW_CREDIT_WARNING 

An alarm triggered by a configured threshold.

ZB_ZCL_PREPAYMENT_ALARM_TOP_UP_CODE_ERROR 

The Top up code has been sent but it is too long or short for the meter

ZB_ZCL_PREPAYMENT_ALARM_TOP_UP_CODE_ALREADY_USED 

The Top up code has been sent but the credit value for this top up code has already been applied and this is a duplicate request.

ZB_ZCL_PREPAYMENT_ALARM_TOP_UP_CODE_INVALID 

The Top up code is a correct length but is not a valid top up code.

ZB_ZCL_PREPAYMENT_ALARM_FRIENDLY_CREDIT_IN_USE 

The meter is in a Friendly Credit period and Friendly Credit is being used due to no actual credit being available on the meter.

ZB_ZCL_PREPAYMENT_ALARM_FRIENDLY_CREDIT_PERIOD_END_WARNING 

This is triggered when the time remaining in a Friendly Credit period falls below the value of the FriendlyCreditWarning attribute (default 1hr) and the above Friendly Credit In Use flag is set.

ZB_ZCL_PREPAYMENT_ALARM_EC_AVAILABLE 

An alarm triggered when Emergency credit is available to be selected

ZB_ZCL_PREPAYMENT_ALARM_UNAUTHORISED_ENERGY_USE 

GAS: Valve Fault and unauthorised gas is being provided to the home ELECTRICITY: Disconnection Fault and unauthorised electricity is being provided to the house.

ZB_ZCL_PREPAYMENT_ALARM_DISCONNECTED_SUPPLY_DUE_TO_CREDIT 

Supply has been disconnected due to no credit on meter. Cleared by addition of credit or by selecting Emergency Credit

ZB_ZCL_PREPAYMENT_ALARM_DISCONNECTED_SUPPLY_DUE_TO_TAMPER 

Supply has been disconnected due to a tamper detect on the meter. It can also be due to a fault on the meter that is not covered by another flag.

ZB_ZCL_PREPAYMENT_ALARM_DISCONNECTED_SUPPLY_DUE_TO_HES 

This is normally due to the HES cutting the supply

ZB_ZCL_PREPAYMENT_ALARM_PHYSICAL_ATTACK 

Physical attack on the Prepayment Meter

ZB_ZCL_PREPAYMENT_ALARM_ELECTRONIC_ATTACK 

Electronic attack on the Prepayment Meter

ZB_ZCL_PREPAYMENT_ALARM_MANUFACTURE_ALARM_CODE_A 

Manufacture Alarm Code A

ZB_ZCL_PREPAYMENT_ALARM_MANUFACTURE_ALARM_CODE_B 

Manufacture Alarm Code B

The Prepayment Information Attribute Set provides access to the standard information relating to a Prepayment meter.

See also
SE spec, subclause 7.2.2.1
Enumerator
ZB_ZCL_ATTR_PREPAYMENT_PAYMENT_CONTROL_CONFIGURATION 

The PaymentControlConfiguration attribute represents the payment mechanisms currently enabled within the Metering Device.

ZB_ZCL_ATTR_PREPAYMENT_CREDIT_REMAINING 

The Credit Remaining attribute represents the amount of credit remaining on the Metering Device.

ZB_ZCL_ATTR_PREPAYMENT_EMERGENCY_CREDIT_REMAINING 

The Emergency Credit Remaining attribute represents the amount of Emergency Credit still available on the Metering Device.

ZB_ZCL_ATTR_PREPAYMENT_CREDIT_STATUS 

The Credit Status attribute represents the current status of credit within the Metering Device.

ZB_ZCL_ATTR_PREPAYMENT_CREDIT_REMAINING_TIMESTAMP 

The UTC time at which the Credit Remaining attribute was last populated.

ZB_ZCL_ATTR_PREPAYMENT_ACCUMULATED_DEBT 

The AccumulatedDebt attribute represents the total amount of debt remaining on the Metering Device.

ZB_ZCL_ATTR_PREPAYMENT_OVERALL_DEBT_CAP 

The OverallDebtCap attribute represents the total amount of debt that can be taken from top-ups (in the case of multiple instantiated top-up based debts on the Metering Device).

ZB_ZCL_ATTR_PREPAYMENT_EMERGENCY_CREDIT_LIMIT 

The EmergencyCreditLimit/Allowance attribute may be updated by the utility company. This is the amount of Emergency Credit available to loan to the consumer when the remaining balance goes below the low credit threshold.

ZB_ZCL_ATTR_PREPAYMENT_EMERGENCY_CREDIT_THRESHOLD 

When credit (or emergency credit) falls below this threshold, an alarm is raised to warn the consumer of imminent supply interruption and, if available, to offer Emergency Credit.

ZB_ZCL_ATTR_PREPAYMENT_TOTAL_CREDIT_ADDED 

An unsigned 48-bit integer value indicating running total of credit topped up to date.

ZB_ZCL_ATTR_PREPAYMENT_MAX_CREDIT_LIMIT 

An unsigned 32-bit integer value indicating the maximum credit balance allowed on a meter.

ZB_ZCL_ATTR_PREPAYMENT_MAX_CREDIT_PER_TOP_UP 

An unsigned 32-bit integer value indicating the maximum credit per top-up. Any single top-up greater than this threshold will cause the meter to reject the top-up

ZB_ZCL_ATTR_PREPAYMENT_FRIENDLY_CREDIT_WARNING 

An unsigned 8-bit integer value indicating the amount of time, in minutes, before the Friendly Credit Period End Warning alarm flag is triggered.

ZB_ZCL_ATTR_PREPAYMENT_LOW_CREDIT_WARNING 

An unsigned 32 bit integer that defines the utility low credit value below which the Low Credit warning should sound.

ZB_ZCL_ATTR_PREPAYMENT_IHD_LOW_CREDIT_WARNING 

An unsigned 32 bit integer that is defined by the consumer for a low credit value below which a Low Credit warning should sound.

ZB_ZCL_ATTR_PREPAYMENT_INTERRUPT_SUSPEND_TIME 

When the end of a configured non-disconnect period is reached and the supply is to be interrupted due to insufficient credit being available, the meter will provide visual and audible alerts and the interruption will be suspended for a further period of minutes defined by this attribute.

ZB_ZCL_ATTR_PREPAYMENT_REMAINING_FRIENDLY_CREDIT_TIMES 

An unsigned 16-bit integer value indicating the amount of time remaining, in minutes, in a currently active Friendly Credit period.

ZB_ZCL_ATTR_PREPAYMENT_NEXT_FRIENDLY_CREDIT_PERIOD 

The UTC time at which the next Friendly Credit period is due to commence.

ZB_ZCL_ATTR_PREPAYMENT_CUT_OFF_VALUE 

This attribute is a signed 32 bit integer that shall either be zero or a negative value (in all known cases).

ZB_ZCL_ATTR_PREPAYMENT_TOKEN_CARRIER_ID 

The TokenCarrierId attribute provides a method for utilities to publish the payment card number that is used with this meter set.

Recovery Frequency Field Enumerations

See also
SE spec, Table D-136
Enumerator
ZB_ZCL_PREPAYMENT_PER_HOUR 

Per Hour

ZB_ZCL_PREPAYMENT_PER_DAY 

Per Day

ZB_ZCL_PREPAYMENT_PER_WEEK 

Per Week

ZB_ZCL_PREPAYMENT_PER_MONTH 

Per Month

ZB_ZCL_PREPAYMENT_PER_QUARTER 

Per Quarter

The Top-up Attribute Set provides access to previous successful credit top-ups on a prepayment meter. #1 is the most recent, based on time.

See also
SE spec, subclause 7.2.2.2
Enumerator
ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_DATE_1 

The Top up Date/Time attribute represents the time that the credit was topped up on the Metering Device. There are five records containing this attribute, one for each of the last five top-ups.

ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_AMOUNT_1 

The Top up Amount attribute represents the amount of credit that was added to the Metering Device during the top up.

ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_ORIGINATING_DEVICE_1 

The Originating Device attribute represents the SE device that was the source of the top-up command.

ZB_ZCL_ATTR_PREPAYMENT_TOP_UP_TOP_UP_CODE_1 

The Top up Code attribute represents any encrypted number that was used to apply the credit to the meter; the octet string shall be as it was received, i.e. not decoded.