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

Data Structures

struct  zb_zcl_prepayment_select_available_emergency_credit_payload_s
 
struct  zb_zcl_prepayment_change_debt_command_payload_s
 
struct  zb_zcl_prepayment_emergency_credit_setup_payload_s
 
struct  zb_zcl_prepayment_consumer_top_up_payload_s
 
struct  zb_zcl_prepayment_credit_adjustment_payload_s
 
struct  zb_zcl_prepayment_change_payment_mode_payload_s
 
struct  zb_zcl_prepayment_get_prepay_snapshot_payload_s
 
struct  zb_zcl_prepayment_get_top_up_log_payload_s
 
struct  zb_zcl_prepayment_get_debt_repayment_log_payload_s
 
struct  zb_zcl_prepayment_set_maximum_credit_limit_payload_s
 
struct  zb_zcl_prepayment_set_overall_debt_cap_payload_s
 
struct  zb_zcl_prepayment_snapshot_payload_s
 
struct  zb_zcl_prepayment_publish_prepay_snapshot_payload_s
 
struct  zb_zcl_prepayment_payment_mode_response_payload_s
 
struct  zb_zcl_prepayment_consumer_top_up_response_payload_s
 
struct  zb_zcl_prepayment_top_up_payload_details_s
 
struct  zb_zcl_prepayment_publish_top_up_log_payload_s
 
struct  zb_zcl_prepayment_debt_payload_record_s
 
struct  zb_zcl_prepayment_publish_debt_log_payload_s
 

Typedefs

typedef enum
zb_zcl_prepayment_cli_cmd_e 
zb_zcl_prepayment_cli_cmd_t
 
typedef enum
zb_zcl_prepayment_originating_device_e 
zb_zcl_prepayment_originating_device_t
 
typedef struct
zb_zcl_prepayment_select_available_emergency_credit_payload_s 
zb_zcl_prepayment_select_available_emergency_credit_payload_t
 
typedef enum
zb_zcl_prepayment_debt_amount_type_e 
zb_zcl_prepayment_debt_amount_type_t
 
typedef struct
zb_zcl_prepayment_change_debt_command_payload_s 
zb_zcl_prepayment_change_debt_command_payload_t
 
typedef struct
zb_zcl_prepayment_emergency_credit_setup_payload_s 
zb_zcl_prepayment_emergency_credit_setup_payload_t
 
typedef struct
zb_zcl_prepayment_consumer_top_up_payload_s 
zb_zcl_prepayment_consumer_top_up_payload_t
 
typedef enum
zb_zcl_prepayment_credit_type_e 
zb_zcl_prepayment_credit_type_t
 
typedef struct
zb_zcl_prepayment_credit_adjustment_payload_s 
zb_zcl_prepayment_credit_adjustment_payload_t
 
typedef struct
zb_zcl_prepayment_change_payment_mode_payload_s 
zb_zcl_prepayment_change_payment_mode_payload_t
 
typedef struct
zb_zcl_prepayment_get_prepay_snapshot_payload_s 
zb_zcl_prepayment_get_prepay_snapshot_payload_t
 
typedef struct
zb_zcl_prepayment_get_top_up_log_payload_s 
zb_zcl_prepayment_get_top_up_log_payload_t
 
typedef zb_uint32_t zb_zcl_prepayment_set_low_credit_warning_level_payload_t
 
typedef enum
zb_zcl_prepayment_debt_type_e 
zb_zcl_prepayment_debt_type_t
 
typedef struct
zb_zcl_prepayment_get_debt_repayment_log_payload_s 
zb_zcl_prepayment_get_debt_repayment_log_payload_t
 
typedef struct
zb_zcl_prepayment_set_maximum_credit_limit_payload_s 
zb_zcl_prepayment_set_maximum_credit_limit_payload_t
 
typedef struct
zb_zcl_prepayment_set_overall_debt_cap_payload_s 
zb_zcl_prepayment_set_overall_debt_cap_payload_t
 
typedef enum
zb_zcl_prepayment_srv_cmd_e 
zb_zcl_prepayment_srv_cmd_t
 
typedef enum
zb_zcl_prepayment_snapshot_payload_cause_e 
zb_zcl_prepayment_snapshot_payload_cause_t
 
typedef enum
zb_zcl_prepayment_snapshot_payload_type_e 
zb_zcl_prepayment_snapshot_payload_type_t
 
typedef struct
zb_zcl_prepayment_snapshot_payload_s 
zb_zcl_prepayment_snapshot_payload_t
 
typedef struct
zb_zcl_prepayment_publish_prepay_snapshot_payload_s 
zb_zcl_prepayment_publish_prepay_snapshot_payload_t
 
typedef enum
zb_zcl_prepayment_friendly_credit_bitmap_e 
zb_zcl_prepayment_friendly_credit_bitmap_t
 
typedef struct
zb_zcl_prepayment_payment_mode_response_payload_s 
zb_zcl_prepayment_payment_mode_response_payload_t
 
typedef enum
zb_zcl_prepayment_result_type_e 
zb_zcl_prepayment_result_type_t
 
typedef struct
zb_zcl_prepayment_consumer_top_up_response_payload_s 
zb_zcl_prepayment_consumer_top_up_response_payload_t
 
typedef struct
zb_zcl_prepayment_top_up_payload_details_s 
zb_zcl_prepayment_top_up_payload_details_t
 
typedef struct
zb_zcl_prepayment_publish_top_up_log_payload_s 
zb_zcl_prepayment_publish_top_up_log_payload_t
 
typedef struct
zb_zcl_prepayment_debt_payload_record_s 
zb_zcl_prepayment_debt_payload_record_t
 
typedef struct
zb_zcl_prepayment_publish_debt_log_payload_s 
zb_zcl_prepayment_publish_debt_log_payload_t
 

Enumerations

enum  zb_zcl_prepayment_cli_cmd_e {
  ZB_ZCL_PREPAYMENT_CLI_CMD_SELECT_AVAILABLE_EMERGENCY_CREDIT = 0x00, ZB_ZCL_PREPAYMENT_CLI_CMD_CHANGE_DEBT = 0x02, ZB_ZCL_PREPAYMENT_CLI_CMD_EMERGENCY_CREDIT_SETUP, ZB_ZCL_PREPAYMENT_CLI_CMD_CONSUMER_TOP_UP,
  ZB_ZCL_PREPAYMENT_CLI_CMD_CREDIT_ADJUSTMENT, ZB_ZCL_PREPAYMENT_CLI_CMD_CHANGE_PAYMENT_MODE, ZB_ZCL_PREPAYMENT_CLI_CMD_GET_PREPAY_SNAPSHOT, ZB_ZCL_PREPAYMENT_CLI_CMD_GET_TOP_UP_LOG,
  ZB_ZCL_PREPAYMENT_CLI_CMD_SET_LOW_CREDIT_WARNING_LEVEL, ZB_ZCL_PREPAYMENT_CLI_CMD_GET_DEBT_REPAYMENT_LOG, ZB_ZCL_PREPAYMENT_CLI_CMD_SET_MAXIMUM_CREDIT_LIMIT, ZB_ZCL_PREPAYMENT_CLI_CMD_SET_OVERALL_DEBT_CAP
}
 
enum  zb_zcl_prepayment_originating_device_e { ZB_ZCL_PREPAYMENT_ORIGINATING_DEVICE_ESI = 0x00, ZB_ZCL_PREPAYMENT_ORIGINATING_DEVICE_METERING, ZB_ZCL_PREPAYMENT_ORIGINATING_DEVICE_IHD }
 
enum  zb_zcl_prepayment_debt_amount_type_e {
  ZB_ZCL_PREPAYMENT_DEBT_AMOUNT_TYPE_1_ABSOLUTE = 0x00, ZB_ZCL_PREPAYMENT_DEBT_AMOUNT_TYPE_1_INCREMENTAL, ZB_ZCL_PREPAYMENT_DEBT_AMOUNT_TYPE_2_ABSOLUTE, ZB_ZCL_PREPAYMENT_DEBT_AMOUNT_TYPE_2_INCREMENTAL,
  ZB_ZCL_PREPAYMENT_DEBT_AMOUNT_TYPE_3_ABSOLUTE, ZB_ZCL_PREPAYMENT_DEBT_AMOUNT_TYPE_3_INCREMENTAL
}
 
enum  zb_zcl_prepayment_credit_type_e { ZB_ZCL_PREPAYMENT_CREDIT_INCREMENTAL = 0x00, ZB_ZCL_PREPAYMENT_CREDIT_ABSOLUTE }
 
enum  zb_zcl_prepayment_debt_type_e { ZB_ZCL_PREPAYMENT_DEBT_TYPE_DEBT_1 = 0x00, ZB_ZCL_PREPAYMENT_DEBT_TYPE_DEBT_2, ZB_ZCL_PREPAYMENT_DEBT_TYPE_DEBT_3, ZB_ZCL_PREPAYMENT_DEBT_TYPE_ALL_DEBTS = 0xFF }
 
enum  zb_zcl_prepayment_srv_cmd_e {
  ZB_ZCL_PREPAYMENT_SRV_CMD_PUBLISH_PREPAY_SNAPSHOT = 0x01, ZB_ZCL_PREPAYMENT_SRV_CMD_CHANGE_PAYMENT_MODE_RESPONSE, ZB_ZCL_PREPAYMENT_SRV_CMD_CONSUMER_TOP_UP_RESPONSE, ZB_ZCL_PREPAYMENT_SRV_CMD_PUBLISH_TOP_UP_LOG = 0x05,
  ZB_ZCL_PREPAYMENT_SRV_CMD_PUBLISH_DEBT_LOG
}
 
enum  zb_zcl_prepayment_snapshot_payload_cause_e {
  ZB_ZCL_PREPAYMENT_CAUSE_GENERAL = 1 << 0, ZB_ZCL_PREPAYMENT_CAUSE_END_OF_BILLING_PERIOD = 1 << 1, ZB_ZCL_PREPAYMENT_CAUSE_TARIFF_INFORMATION_CHANGE = 1 << 3, ZB_ZCL_PREPAYMENT_CAUSE_PRICE_MATRIX_CHANGE = 1 << 4,
  ZB_ZCL_PREPAYMENT_CAUSE_MANUALLY_TRIGGERED_FROM_CLIENT = 1 << 10, ZB_ZCL_PREPAYMENT_CAUSE_TENANCY_CHANGE = 1 << 12, ZB_ZCL_PREPAYMENT_CAUSE_SUPPLIER_CHANGE = 1 << 13, ZB_ZCL_PREPAYMENT_CAUSE_METER_MODE_CHANGE = 1 << 14,
  ZB_ZCL_PREPAYMENT_CAUSE_TOP_UP_ADDITION = 1 << 18, ZB_ZCL_PREPAYMENT_CAUSE_DEBT_AND_CREDIT_ADDITION = 1 << 19
}
 
enum  zb_zcl_prepayment_snapshot_payload_type_e { ZB_ZCL_PREPAYMENT_SNAPSHOT_PAYLOAD_TYPE_DEBT_AND_CREDIT_STATUS = 0x00 }
 
enum  zb_zcl_prepayment_friendly_credit_bitmap_e { PREPAYMENT_FRIENDLY_CREDIT_ENABLED = 0 }
 
enum  zb_zcl_prepayment_result_type_e {
  ZB_ZCL_PREPAYMENT_RESULT_ACCEPTED = 0x00, ZB_ZCL_PREPAYMENT_RESULT_REJECTED_INVALID_TOP_UP, ZB_ZCL_PREPAYMENT_RESULT_REJECTED_DUPLICATE_TOP_UP, ZB_ZCL_PREPAYMENT_RESULT_REJECTED_ERROR,
  ZB_ZCL_PREPAYMENT_RESULT_REJECTED_MAX_CREDIT_REACHED, ZB_ZCL_PREPAYMENT_RESULT_REJECTED_KAYPAD_LOCK, ZB_ZCL_PREPAYMENT_RESULT_REJECTED_TOP_UP_VALUE_TOO_LARGE, ZB_ZCL_PREPAYMENT_RESULT_ACCEPTED_SUPPLY_ENABLED = 0x10,
  ZB_ZCL_PREPAYMENT_RESULT_ACCEPTED_SUPPLY_DISABLED, ZB_ZCL_PREPAYMENT_RESULT_ACCEPTED_SUPPLY_ARMED
}
 

Detailed Description

Typedef Documentation

Change Debt Command Payload

See also
SE spec, subclause 7.2.3.3

Change Payment Mode Command Payload

See also
SE spec, subclause D.7.2.3.7

Commands are generated by Prepayment Client.

See also
SE spec, subclause 7.2.3

Consumer Top Up Command is used by the IHD and the ESI as a method to apply credit top up values to a prepayment meter.

See also
SE spec, subclause D.7.2.3.5

Consumer Top Up Response Command Payload

See also
SE spec, subclause 7.2.4.4

The Credit Adjustment command Payload

See also
SE spec, subclause D.7.2.3.6

Credit Type Field Enumerations

See also
SE spec, Table D-148

Debt Amount Type Field Enumerations

See also
SE spec, Table D-147

Format of a Debt Payload Record

See also
SE spec, Figure D-134

Debt Type Field Enumerations

See also
SE spec, Table D-149

Emergency Credit Setup Command Payload

See also
SE spec, subclause D.7.2.3.4

Friendly Credit BitMap

See also
SE spec, Table D-153

Get Debt Repayment Log Command Payload

See also
SE spec, table D.7.2.3.11

Get Prepay Snapshot Command Payload

See also
SE spec, subclause D.7.2.3.8

Get Top Up Log Payload

See also
SE spec, subclause D.7.2.3.9

Originating Device Field Enumerations

See also
SE spec, Table D-146

Change Payment Mode Response Command Payload

See also
SE spec, subclause 7.2.4.3

Publish Debt Log Command Payload

See also
SE spec, subclause 7.2.4.6

Publish Prepay Snapshot Command Payload

See also
SE spec, subclause 7.2.4.2

Publish Top Up Log Command Payload

See also
SE spec, subclause 7.2.4.5

Result Type Field Enumerations

See also
SE spec, Table D-154

Select Available Emergency Credit Command Payload

See also
SE spec, subclause 7.2.3.1

Set Low Credit Warning Level Payload.

See also
SE spec, subclause D.7.2.3.10

Set Maximum Credit Limit Payload

See also
SE spec, subclause D.7.2.3.12

Set Overall Debt Cap Payload

See also
SE spec, subclause D.7.2.3.13

Snapshot Payload Cause

See also
SE spec, Table D-151

Debt/Credit Status Command Payload

See also
SE spec, Figure D-128

Snapshot Payload Type

See also
SE spec, Table D-152

Commands are generated by Prepayment Server.

See also
SE spec, subclause D.7.2.4

Top Up Payload Details

See also
SE spec, Figure D-132

Enumeration Type Documentation

Commands are generated by Prepayment Client.

See also
SE spec, subclause 7.2.3
Enumerator
ZB_ZCL_PREPAYMENT_CLI_CMD_SELECT_AVAILABLE_EMERGENCY_CREDIT 

This command is sent to the Metering Device to activate the use of any Emergency Credit available on the Metering Device.

ZB_ZCL_PREPAYMENT_CLI_CMD_CHANGE_DEBT 

The ChangeDebt command is sent to the Metering Device to change the debt values.

ZB_ZCL_PREPAYMENT_CLI_CMD_EMERGENCY_CREDIT_SETUP 

This command provides a method to set up the parameters for the Emergency Credit.

ZB_ZCL_PREPAYMENT_CLI_CMD_CONSUMER_TOP_UP 

The follow command is used by the IHD and the ESI as a method to apply credit top up values to a prepayment meter.

ZB_ZCL_PREPAYMENT_CLI_CMD_CREDIT_ADJUSTMENT 

The follow command is sent to update the Credit Remaining attribute on a Prepayment meter. It shall only be sent from an ESI to the Meter.

ZB_ZCL_PREPAYMENT_CLI_CMD_CHANGE_PAYMENT_MODE 

This command is sent to a Metering Device to instruct it to change its mode of operation, e.g. from Credit to Prepayment.

ZB_ZCL_PREPAYMENT_CLI_CMD_GET_PREPAY_SNAPSHOT 

This command is used to request the cluster server for snapshot data.

ZB_ZCL_PREPAYMENT_CLI_CMD_GET_TOP_UP_LOG 

This command is sent to the Metering Device to retrieve the log of Top Up codes received by the meter.

ZB_ZCL_PREPAYMENT_CLI_CMD_SET_LOW_CREDIT_WARNING_LEVEL 

This command is sent from client to a Prepayment server to set the warning level for low credit.

ZB_ZCL_PREPAYMENT_CLI_CMD_GET_DEBT_REPAYMENT_LOG 

This command is used to request the contents of the Repayment log.

ZB_ZCL_PREPAYMENT_CLI_CMD_SET_MAXIMUM_CREDIT_LIMIT 

This command is sent from a client to the Prepayment server to set the maximum credit level allowed in the meter.

ZB_ZCL_PREPAYMENT_CLI_CMD_SET_OVERALL_DEBT_CAP 

This command is sent from a client to the Prepayment server to set the overall debt cap allowed in the meter.

Credit Type Field Enumerations

See also
SE spec, Table D-148

Debt Amount Type Field Enumerations

See also
SE spec, Table D-147

Debt Type Field Enumerations

See also
SE spec, Table D-149

Friendly Credit BitMap

See also
SE spec, Table D-153

Originating Device Field Enumerations

See also
SE spec, Table D-146

Result Type Field Enumerations

See also
SE spec, Table D-154

Snapshot Payload Cause

See also
SE spec, Table D-151

Snapshot Payload Type

See also
SE spec, Table D-152

Commands are generated by Prepayment Server.

See also
SE spec, subclause D.7.2.4
Enumerator
ZB_ZCL_PREPAYMENT_SRV_CMD_PUBLISH_PREPAY_SNAPSHOT 

This command is generated in response to a GetPrepaySnapshot command or when a new snapshot is created. It is used to return a single snapshot to the client.

ZB_ZCL_PREPAYMENT_SRV_CMD_CHANGE_PAYMENT_MODE_RESPONSE 

This command is sent in response to the ChangePaymentMode command. This command shall only inform the ESI of the current default setting that would affect the meter when entering into Prepayment/PAYG or Credit mode. Should these values require changing then other commands within the Prepayment & Price cluster should be used.

ZB_ZCL_PREPAYMENT_SRV_CMD_PUBLISH_TOP_UP_LOG 

This command is used to send the Top Up Code Log entries to the Prepayment client. The command shall be sent in response to a Get Top Up Log command and MAY be sent unsolicited whenever a new Top Up code is received and successfully processed

ZB_ZCL_PREPAYMENT_SRV_CMD_PUBLISH_DEBT_LOG 

This command is used to send the contents of the Repayment Log.