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)

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)

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)

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)

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 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)

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 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)

A Collection of Registers

class curb_energy.schema.SensorGroupSchema(extra=None, only=(), exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

A group of one or more Sensors measuring power at a common location

class curb_energy.schema.SensorSchema(extra=None, only=(), exclude=(), prefix='', strict=None, many=False, context=None, load_only=(), dump_only=(), partial=False)

An energy measuring device, like the Curb Hub