Developing with ZBOSS for Zigbee

Typedefs

typedef enum zb_zcl_price_credit_payment_status_e zb_zcl_price_credit_payment_status_t
 CreditPaymentStatus attribute values More...
 

Enumerations

enum  zb_zcl_price_set_credit_payment_e {
  ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_DUE_DATE = ZB_ZCL_ATTR_SET_WITH_ATTR_ID(ZB_ZCL_PRICE_SET_CREDIT_PAYMENT, 0x00), ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_STATUS, ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_OVER_DUE_AMOUNT, ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT = ZB_ZCL_ATTR_SET_WITH_ATTR_ID(ZB_ZCL_PRICE_SET_CREDIT_PAYMENT, 0x0A),
  ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_PERIOD, ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_1 = ZB_ZCL_ATTR_SET_WITH_ATTR_ID(ZB_ZCL_PRICE_SET_CREDIT_PAYMENT, 0x10), ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_DATE_1, ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_REF_1,
  ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_2 = ZB_ZCL_ATTR_SET_WITH_ATTR_ID(ZB_ZCL_PRICE_SET_CREDIT_PAYMENT, 0x20), ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_DATE_2, ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_REF_2, ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_3 = ZB_ZCL_ATTR_SET_WITH_ATTR_ID(ZB_ZCL_PRICE_SET_CREDIT_PAYMENT, 0x30),
  ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_DATE_3, ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_REF_3, ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_4 = ZB_ZCL_ATTR_SET_WITH_ATTR_ID(ZB_ZCL_PRICE_SET_CREDIT_PAYMENT, 0x40), ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_DATE_4,
  ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_REF_4, ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_5 = ZB_ZCL_ATTR_SET_WITH_ATTR_ID(ZB_ZCL_PRICE_SET_CREDIT_PAYMENT, 0x50), ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_DATE_5, ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_REF_5
}
 Credit Payment Attributes Set. More...
 
enum  zb_zcl_price_credit_payment_status_e {
  ZB_ZCL_PRICE_CREDIT_PAYMENT_PENDING = 0x00, ZB_ZCL_PRICE_CREDIT_PAYMENT_RECEIVED = 0x01, ZB_ZCL_PRICE_CREDIT_PAYMENT_PAID = ZB_ZCL_PRICE_CREDIT_PAYMENT_RECEIVED, ZB_ZCL_PRICE_CREDIT_PAYMENT_OVERDUE = 0x02,
  ZB_ZCL_PRICE_CREDIT_PAYMENT_2PAYMENTS_OVERDUE = 0x03, ZB_ZCL_PRICE_CREDIT_PAYMENT_3PAYMENTS_OVERDUE = 0x04
}
 CreditPaymentStatus attribute values More...
 

Detailed Description

The Credit Payments Attribute set provides a method for the HAN (IHD) to understand the current status of the credit-only payment made to the energy supplier. These payments are for a credit meter only and do not cover any Prepayment Top up or payment. This attribute set is used to display the bill on the IHD should this service be required. Devices that require this information should use standard ZCL commands to read this information.

Typedef Documentation

◆ zb_zcl_price_credit_payment_status_t

CreditPaymentStatus attribute values

See also
SE spec, Table D-86.
ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_STATUS

Enumeration Type Documentation

◆ zb_zcl_price_credit_payment_status_e

CreditPaymentStatus attribute values

See also
SE spec, Table D-86.
ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_STATUS
Enumerator
ZB_ZCL_PRICE_CREDIT_PAYMENT_PENDING 

Pending

ZB_ZCL_PRICE_CREDIT_PAYMENT_RECEIVED 

Received/Paid

ZB_ZCL_PRICE_CREDIT_PAYMENT_PAID 

Received/Paid

ZB_ZCL_PRICE_CREDIT_PAYMENT_OVERDUE 

Overdue

ZB_ZCL_PRICE_CREDIT_PAYMENT_2PAYMENTS_OVERDUE 

2 Payments overdue

ZB_ZCL_PRICE_CREDIT_PAYMENT_3PAYMENTS_OVERDUE 

3 Payments overdue

◆ zb_zcl_price_set_credit_payment_e

Credit Payment Attributes Set.

See also
SE spec, D.2.2.9
Enumerator
ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_DUE_DATE 

The CreditPaymentDueDate attribute indicates the date and time when the next credit payment is due to be paid by the consumer to the supplier.

ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_STATUS 

The CreditPaymentStatus attribute indicates the current status of the last payment.

ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_OVER_DUE_AMOUNT 

This is the total of the consolidated bill amounts accumulated since the last payment.

ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT 

The PaymentDiscount attribute indicates the discount that the energy supplier has applied to the consolidated bill.

ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_PERIOD 

The PaymentDiscountPeriod attribute indicates the period for which this discount shall be applied for.

ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_1 

The CreditPayment attributes indicate the amount paid by the consumer to the energy supplier.

ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_DATE_1 

The CreditPaymentDate attributes indicate the last time the consumer made a payment to the energy supplier.

ZB_ZCL_ATTR_PRICE_SRV_CREDIT_PAYMENT_REF_1 

The CreditPaymentRef attributes indicate the reference number given to the payment by the energy supplier.