Model Module

class Taipower.model.TaipowerAMI(ami: dict)[source]

Bases: object

Taipower AMI.

Parameters

ami (dict) – AMI.

property start_time: str

Start time.

Returns

In yyyymmddhhmmss format.

Return type

str

property end_time: str

End time.

Returns

In yyyymmddhhmmss format.

Return type

str

property is_missing_data: bool

Whether or not the data is missing (unrecorded).

Returns

Return True if the data is missing.

Return type

bool

property offpeak_kwh: Optional[float]

Off-peak kw/h.

Returns

Off-peak kwh. Return None if the ami period is quater.

Return type

Optional[float]

property halfpeak_kwh: Optional[float]

Half-peak kw/h.

Returns

Half-peak kwh. Return None if the ami period is quater.

Return type

Optional[float]

property satpeak_kwh: Optional[float]

Saturday half-peak kw/h.

Returns

Saturday half-peak kwh. Return None if the ami period is quater.

Return type

Optional[float]

property peak_kwh: Optional[float]

Peak kw/h.

Returns

Peak kwh. Return None if the ami period is quater.

Return type

Optional[float]

property total_kwh: Optional[float]

Total kw/h.

Returns

Total kwh.

Return type

Optional[float]

class Taipower.model.TaipowerAMIBill(bill: dict)[source]

Bases: object

Taipower AMI bill.

Parameters

bill (dict) – Bill.

property bill_start_date: str

Bill start date.

Returns

In yyyy/mm format.

Return type

str

property bill_end_date: str

Bill end date.

Returns

In yyyy/mm format.

Return type

str

property current_amount: int

Current amount.

Returns

Current amount.

Return type

int

property kwh: int

Kw/h.

Returns

Kw/h.

Return type

int

property last_cycle_kwh: int

Last cycle kw/h.

Returns

Last cycle kw/h.

Return type

int

property last_year_kwh: int

The cycle in last year kw/h.

Returns

The same cycle in last year kw/h.

Return type

int

class Taipower.model.TaipowerAMIUnbilled(unbilled_data: dict)[source]

Bases: object

Taipower AMI unbilled data.

Parameters

unbilled_data (dict) – AMI unbilled data.

property charge: int

Amount.

Returns

The amount of the unbilled data.

Return type

int

property deadline: str

Deadline.

Returns

In yyyymmdd format.

Return type

str

property kwh: float

Kw/h.

Returns

Kw/h.

Return type

float

property reading_date: str

The meter reading date.

Returns

In yyyymmdd format.

Return type

str

property last_reading_date: str

The last meter reading date.

Returns

In yyyymmdd format.

Return type

str

property next_reading_date: str

The next meter reading date.

Returns

In yyyymmdd format.

Return type

str

class Taipower.model.TaipowerBillRecord(bill_record: dict)[source]

Bases: object

Taipower bill record.

Parameters

bill_record (dict) – Bill record.

property charge: int

The amount of the bill.

Returns

The amount of the bill.

Return type

int

property formula: str

The formula of the bill.

Returns

The formula of the bill.

Return type

str

property kwh: int

The kw/h consumed in the bill cycle.

Returns

The kw/h consumed in the bill cycle.

Return type

int

property period: str

The period of the bill cycle.

Returns

In yyy/mm/dd~yyy/mm/dd (ROC calendar) format.

Return type

str

property paid: bool

Whether or not the bill is paid.

Returns

Return True if paid.

Return type

bool