curb_energy.schema
¶
The schema module helps convert the Curb API REST resources into Python-friendly objects.
-
class
curb_energy.schema.
BillingModelSchema
(extra=None, only=(), exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]¶ Billing Model: Utility/Provider information
-
class
curb_energy.schema.
BillingSchema
(extra=None, only=(), exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]¶ Billing Information for the monitored location
-
class
curb_energy.schema.
DeviceSchema
(extra=None, only=(), exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]¶ A monitored “location”, such as a home/building.
Todo
Why does Curb API call it “Device”?
-
class
curb_energy.schema.
ProfileSchema
(extra=None, only=(), exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]¶ Profiles define how to interpret data, access real time data, and various other configuration options.
-
class
curb_energy.schema.
RealTimeSchema
(extra=None, only=(), exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]¶ Source for Real-time data
-
class
curb_energy.schema.
RegisterGroupsSchema
(extra=None, only=(), exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]¶ A logical grouping of Registers.
-
class
curb_energy.schema.
RegisterSchema
(extra=None, only=(), exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]¶ Source for a single stream of power data. They can correspond to a physical circuit breaker.
-
class
curb_energy.schema.
RegistersSchema
(extra=None, only=(), exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)[source]¶ A Collection of Registers