curb_energy.models
¶
Classes for representing the Curb API resources
-
class
curb_energy.models.
Billing
(profile_id=-1, billing_model=None, day_of_month=1, zip_code=None, dollar_per_kwh=None, **kwargs)[source]¶ Billing describes how and when the customer is billed and is associated with a
BillingModel
instance.-
__init__
(profile_id=-1, billing_model=None, day_of_month=1, zip_code=None, dollar_per_kwh=None, **kwargs)[source]¶ The billing configuration for the customer
Parameters: - profile_id (
int
) – The Curb configuration profile - billing_model (
Optional
[BillingModel
]) – Billing model information - day_of_month (
int
) – The start day of the billing period - zip_code (
Optional
[int
]) – The zip code of the dwelling being monitored - dollar_per_kwh (
Optional
[float
]) – The price per kilowatt-hour
- profile_id (
-
-
class
curb_energy.models.
BillingModel
(sector='Residential', label=None, utility=None, name=None, **kwargs)[source]¶ The Billing Model describes the utility and billing tier for a given customer.
-
class
curb_energy.models.
Device
(id=-1, building_type=None, name=None, timezone=None, sensor_groups=None, **kwargs)[source]¶ A logical grouping of Sensor Groups. A “device” can be thought of as a unit representing a location being measured, such as a home.
Todo
Clarify with Curb what they really intend by this.
-
class
curb_energy.models.
Measurement
(granularity, since, until, unit, headers, data)¶ -
data
¶ Alias for field number 5
-
granularity
¶ Alias for field number 0
-
headers
¶ Alias for field number 4
-
since
¶ Alias for field number 1
-
unit
¶ Alias for field number 3
-
until
¶ Alias for field number 2
-
-
class
curb_energy.models.
Profile
(id=-1, display_name=None, real_time=None, register_groups=None, registers=None, widgets=None, billing=None, **kwargs)[source]¶ A profile defines how to interpret data, access real time data, and various other configuration options.
-
__init__
(id=-1, display_name=None, real_time=None, register_groups=None, registers=None, widgets=None, billing=None, **kwargs)[source]¶ Create an instance of a configuration profile
Parameters: - id (
int
) – The unique ID of the profile - display_name (
Optional
[str
]) – The friendly name of this profile/configuration - real_time (
Optional
[RealTimeConfig
]) – The configuration for the real-time API - register_groups (
Optional
[List
[RegisterGroup
]]) – The register groups associated with this config - registers (
Optional
[List
[Register
]]) – The list of registers associated with this config - widgets (
Optional
[List
[type
]]) – The list of widgets - billing (
Optional
[Billing
]) – The billing configuration
- id (
-
-
class
curb_energy.models.
RealTimeConfig
(topic=None, format='curb', prefix=None, ws_url=None, **kwargs)[source]¶ Configuration for the Real-Time client
-
class
curb_energy.models.
Register
(id='', multiplier=1, flip_domain=False, label=None, **kwargs)[source]¶ A source of power measurement data.
-
class
curb_energy.models.
RegisterGroup
(grid, normals, solar, use)[source]¶ A logical grouping of registers according to classification
-
class
curb_energy.models.
Sensor
(id=-1, name=None, arbitrary_name=None, **kwargs)[source]¶ An energy monitoring device (in this case, the Curb Hub)