CPAU

API Reference

  • Session Management
    • CpauApiSession
      • CpauApiSession.__init__()
      • CpauApiSession.login()
      • CpauApiSession.get_electric_meters()
      • CpauApiSession.get_electric_meter()
      • CpauApiSession.is_authenticated
      • CpauApiSession.session
      • CpauApiSession.close()
      • CpauApiSession.__enter__()
      • CpauApiSession.__exit__()
    • CpauApiSession
      • CpauApiSession
        • CpauApiSession.__init__()
        • CpauApiSession.login()
        • CpauApiSession.get_electric_meters()
        • CpauApiSession.get_electric_meter()
        • CpauApiSession.is_authenticated
        • CpauApiSession.session
        • CpauApiSession.close()
        • CpauApiSession.__enter__()
        • CpauApiSession.__exit__()
  • Electric Meter
    • CpauElectricMeter
      • CpauElectricMeter.get_available_intervals()
      • CpauElectricMeter.rate_category
      • CpauElectricMeter.get_usage()
      • CpauElectricMeter.get_billing_usage()
      • CpauElectricMeter.get_monthly_usage()
      • CpauElectricMeter.get_daily_usage()
      • CpauElectricMeter.get_hourly_usage()
      • CpauElectricMeter.get_15min_usage()
      • CpauElectricMeter.get_availability_window()
      • CpauElectricMeter.iter_usage()
    • CpauElectricMeter
      • CpauElectricMeter
        • CpauElectricMeter.get_available_intervals()
        • CpauElectricMeter.rate_category
        • CpauElectricMeter.get_usage()
        • CpauElectricMeter.get_billing_usage()
        • CpauElectricMeter.get_monthly_usage()
        • CpauElectricMeter.get_daily_usage()
        • CpauElectricMeter.get_hourly_usage()
        • CpauElectricMeter.get_15min_usage()
        • CpauElectricMeter.get_availability_window()
        • CpauElectricMeter.iter_usage()
        • CpauElectricMeter.__init__()
        • CpauElectricMeter.__repr__()
        • CpauElectricMeter.address
        • CpauElectricMeter.meter_number
        • CpauElectricMeter.meter_type
        • CpauElectricMeter.status
    • UsageRecord
      • UsageRecord
        • UsageRecord.date
        • UsageRecord.import_kwh
        • UsageRecord.export_kwh
        • UsageRecord.net_kwh
        • UsageRecord.billing_period_start
        • UsageRecord.billing_period_end
        • UsageRecord.billing_period_length
        • UsageRecord.date
        • UsageRecord.import_kwh
        • UsageRecord.export_kwh
        • UsageRecord.net_kwh
        • UsageRecord.billing_period_start
        • UsageRecord.billing_period_end
        • UsageRecord.billing_period_length
        • UsageRecord.__init__()
  • Water Meter
    • CpauWaterMeter
      • CpauWaterMeter.__init__()
      • CpauWaterMeter.get_available_intervals()
      • CpauWaterMeter.get_usage()
      • CpauWaterMeter.get_billing_usage()
      • CpauWaterMeter.get_monthly_usage()
      • CpauWaterMeter.get_daily_usage()
      • CpauWaterMeter.get_hourly_usage()
      • CpauWaterMeter.get_availability_window()
      • CpauWaterMeter.__repr__()
    • CpauWaterMeter
      • CpauWaterMeter
        • CpauWaterMeter.__init__()
        • CpauWaterMeter.get_available_intervals()
        • CpauWaterMeter.get_usage()
        • CpauWaterMeter.get_billing_usage()
        • CpauWaterMeter.get_monthly_usage()
        • CpauWaterMeter.get_daily_usage()
        • CpauWaterMeter.get_hourly_usage()
        • CpauWaterMeter.get_availability_window()
        • CpauWaterMeter.__repr__()
    • WatersmartSessionManager
      • WatersmartSessionManager
        • WatersmartSessionManager.__init__()
        • WatersmartSessionManager.authenticate()
        • WatersmartSessionManager.is_authenticated()
        • WatersmartSessionManager.get_session()
        • WatersmartSessionManager.get_authentication_age()
      • WatersmartSessionManager
        • WatersmartSessionManager.__init__()
        • WatersmartSessionManager.authenticate()
        • WatersmartSessionManager.is_authenticated()
        • WatersmartSessionManager.get_session()
        • WatersmartSessionManager.get_authentication_age()
  • Exceptions
    • CpauError
    • CpauConnectionError
    • CpauAuthenticationError
    • CpauApiError
    • CpauMeterNotFoundError
    • Exception Hierarchy
    • Exception Classes
      • CpauError
        • CpauError
      • CpauAuthenticationError
        • CpauAuthenticationError
      • CpauConnectionError
        • CpauConnectionError
      • CpauApiError
        • CpauApiError
      • CpauMeterNotFoundError
        • CpauMeterNotFoundError
    • Example Usage
CPAU
  • Overview: module code

All modules for which code is available

  • cpau.electric_meter
  • cpau.exceptions
  • cpau.meter
  • cpau.session
  • cpau.water_meter
  • cpau.watersmart_session

© Copyright 2025, Joe Sinnott.

Built with Sphinx using a theme provided by Read the Docs.