sungazer

Getting Started

  • Installation
    • Prerequisites
    • Installation Methods
      • From PyPI with pip
      • From PyPI with uv
      • From Source
    • Verification
    • Dependencies
    • Development Installation
    • Configuration
    • Getting Help
  • Quickstart Guide
    • Prerequisites
    • Basic Usage with Python Client
      • Getting info about the PVS6 device itself
      • Getting Device Information
      • Checking Network Status
      • Checking Firmware
      • Using Context Manager
    • Basic Usage with Command Line
      • Getting Help
      • Starting a Session
      • Listing Devices
      • Checking Network Status
      • Checking Firmware
    • Configuration for the Command Line Tool
    • Next Steps
    • Troubleshooting
      • Common Issues
    • Getting Help

User Guide

  • Connecting to Your PVS6 Device
    • Identifying Your Device Type
    • Connection Methods
      • Direct Ethernet Connection (Older Models)
      • USB Ethernet Adapter (Newer Models)
    • Configure your computer’s Network
      • OS Specific Instructions
    • Test Connectivity
    • Troubleshooting
      • Connection Issues
    • Getting Help
  • Configuration: Python Client
    • Direct Configuration
    • Advanced Configuration
      • SSL Configuration
    • SSL Certificate Handling
      • Troubleshooting Configuration
    • Common Issues
      • Configuration Validation
    • Validation Rules
    • Error Messages
  • Using the Python Client
    • Client Initialization
      • Basic Client Setup
      • Advanced Configuration
      • Context Manager Usage
    • Session Management
      • Starting a Session
      • Stopping a Session
      • Supervisor Information
    • Device Management
      • Listing All Devices
      • Device-Specific Data
      • Device Details
    • Network Management
      • Network Status Overview
      • Interface Details
    • Firmware Management
      • Firmware Status
    • Grid Profile Management
      • Get Current Profile
      • Refresh Grid Profile
    • Error Handling
      • HTTP Errors
      • Session Errors
    • Best Practices
      • Error Recovery
      • Resource Management
    • Performance Considerations
      • Connection Reuse
      • Timeout Configuration
    • Advanced Usage
      • Custom HTTP Client
      • Data Processing
    • Automation Examples
      • Monitoring Script
      • Data Collection
  • Configuration: Command Line Tool
    • Configuration Methods
    • Configuration Files
      • File Locations
      • File Format
      • Configuration Options
    • Environment Variables
      • Environment Variable Mapping
    • Command-Line Options
      • Global Options
      • Option Reference
    • Configuration Examples
      • Basic Setup
      • Multiple Devices
      • Production Environment
      • Development Environment
    • Network-Specific Configuration
      • Local Network
      • Remote Access
      • Slow Networks
    • Security Considerations
      • Configuration File Security
      • Environment Variable Security
    • Troubleshooting Configuration
      • Configuration Debugging
      • Common Issues
    • Configuration Validation
      • Validation Rules
      • Error Messages
    • Best Practices
      • Configuration Management
    • Configuration Templates
      • Basic Template
      • Production Template
      • Development Template
  • Using the Command Line Interface
    • Getting Help
      • Basic Help
    • Command Structure
    • Global Options
    • Session Management
      • Starting a Session
      • Stopping a Session
    • Device Management
      • Listing All Devices
      • Device-Specific Commands
    • Network Management
      • Network Status
    • Firmware Management
      • Check Firmware
    • Grid Profile Management
      • Get Current Profile
      • Refresh Grid Profile
    • Output Formats
      • JSON Format (Default)
      • Table Format
    • Configuration
    • Examples
      • Basic Usage Examples
      • Advanced Usage Examples
      • Scripting Examples
    • Error Handling
      • Common Error Scenarios
    • Troubleshooting
      • Debugging Commands
      • Common Issues
    • Best Practices
      • Output Format Selection
      • Configuration Management

Reference

  • SunPower Bankruptcy and Current State
    • Bankruptcy Timeline
    • Who was involved in the SunPower bankruptcy?
    • Summary
    • References
  • SunStrong Management and you
  • SunPower PVS6 API Models
    • Request and Response Models
    • Devices
      • BaseDeviceDetail
        • BaseDeviceDetail.CURTIME
        • BaseDeviceDetail.DATATIME
        • BaseDeviceDetail.DEVICE_TYPE
        • BaseDeviceDetail.HWVER
        • BaseDeviceDetail.ISDETAIL
        • BaseDeviceDetail.MODEL
        • BaseDeviceDetail.OPERATION
        • BaseDeviceDetail.PORT
        • BaseDeviceDetail.SERIAL
        • BaseDeviceDetail.STATE
        • BaseDeviceDetail.STATEDESCR
        • BaseDeviceDetail.SWVER
        • BaseDeviceDetail.TYPE
        • BaseDeviceDetail.origin
        • BaseDeviceDetail.panid
        • BaseDeviceDetail.construct
        • BaseDeviceDetail.model_copy
        • BaseDeviceDetail.model_validate
        • BaseDeviceDetail.model_validate_json
        • BaseDeviceDetail.model_validate_strings
        • BaseDeviceDetail.parse_file
        • BaseDeviceDetail.parse_obj
        • BaseDeviceDetail.parse_raw
        • BaseDeviceDetail.parse_timestamp
      • Battery
        • Battery.CURTIME
        • Battery.DATATIME
        • Battery.DESCR
        • Battery.DEVICE_TYPE
        • Battery.HWVER
        • Battery.ISDETAIL
        • Battery.MODEL
        • Battery.OPERATION
        • Battery.PARENT
        • Battery.PORT
        • Battery.SERIAL
        • Battery.STATE
        • Battery.STATEDESCR
        • Battery.SWVER
        • Battery.TYPE
        • Battery.hw_version
        • Battery.interface
        • Battery.origin
        • Battery.panid
        • Battery.parent
        • Battery.construct
        • Battery.model_copy
        • Battery.model_validate
        • Battery.model_validate_json
        • Battery.model_validate_strings
        • Battery.parse_file
        • Battery.parse_obj
        • Battery.parse_raw
        • Battery.parse_timestamp
      • ConsumptionPowerMeterDeviceDetail
        • ConsumptionPowerMeterDeviceDetail.CAL0
        • ConsumptionPowerMeterDeviceDetail.CURTIME
        • ConsumptionPowerMeterDeviceDetail.DATATIME
        • ConsumptionPowerMeterDeviceDetail.DEVICE_TYPE
        • ConsumptionPowerMeterDeviceDetail.HWVER
        • ConsumptionPowerMeterDeviceDetail.ISDETAIL
        • ConsumptionPowerMeterDeviceDetail.MODEL
        • ConsumptionPowerMeterDeviceDetail.OPERATION
        • ConsumptionPowerMeterDeviceDetail.PORT
        • ConsumptionPowerMeterDeviceDetail.SERIAL
        • ConsumptionPowerMeterDeviceDetail.STATE
        • ConsumptionPowerMeterDeviceDetail.STATEDESCR
        • ConsumptionPowerMeterDeviceDetail.SWVER
        • ConsumptionPowerMeterDeviceDetail.TYPE
        • ConsumptionPowerMeterDeviceDetail.consumption_subtype_enum
        • ConsumptionPowerMeterDeviceDetail.ct_scl_fctr
        • ConsumptionPowerMeterDeviceDetail.freq_hz
        • ConsumptionPowerMeterDeviceDetail.i1_a
        • ConsumptionPowerMeterDeviceDetail.i2_a
        • ConsumptionPowerMeterDeviceDetail.interface
        • ConsumptionPowerMeterDeviceDetail.neg_ltea_3phsum_kwh
        • ConsumptionPowerMeterDeviceDetail.net_ltea_3phsum_kwh
        • ConsumptionPowerMeterDeviceDetail.origin
        • ConsumptionPowerMeterDeviceDetail.p1_kw
        • ConsumptionPowerMeterDeviceDetail.p2_kw
        • ConsumptionPowerMeterDeviceDetail.p_3phsum_kw
        • ConsumptionPowerMeterDeviceDetail.panid
        • ConsumptionPowerMeterDeviceDetail.pos_ltea_3phsum_kwh
        • ConsumptionPowerMeterDeviceDetail.q_3phsum_kvar
        • ConsumptionPowerMeterDeviceDetail.s_3phsum_kva
        • ConsumptionPowerMeterDeviceDetail.subtype
        • ConsumptionPowerMeterDeviceDetail.tot_pf_rto
        • ConsumptionPowerMeterDeviceDetail.v12_v
        • ConsumptionPowerMeterDeviceDetail.v1n_v
        • ConsumptionPowerMeterDeviceDetail.v2n_v
        • ConsumptionPowerMeterDeviceDetail.construct
        • ConsumptionPowerMeterDeviceDetail.model_copy
        • ConsumptionPowerMeterDeviceDetail.model_validate
        • ConsumptionPowerMeterDeviceDetail.model_validate_json
        • ConsumptionPowerMeterDeviceDetail.model_validate_strings
        • ConsumptionPowerMeterDeviceDetail.parse_file
        • ConsumptionPowerMeterDeviceDetail.parse_obj
        • ConsumptionPowerMeterDeviceDetail.parse_raw
        • ConsumptionPowerMeterDeviceDetail.parse_timestamp
      • DeviceDetailResponse
        • DeviceDetailResponse.devices
        • DeviceDetailResponse.result
        • DeviceDetailResponse.construct
        • DeviceDetailResponse.model_copy
        • DeviceDetailResponse.model_validate
        • DeviceDetailResponse.model_validate_json
        • DeviceDetailResponse.model_validate_strings
        • DeviceDetailResponse.new
        • DeviceDetailResponse.parse_file
        • DeviceDetailResponse.parse_obj
        • DeviceDetailResponse.parse_raw
        • DeviceDetailResponse.consumption_meter
        • DeviceDetailResponse.inverters
        • DeviceDetailResponse.production_meter
        • DeviceDetailResponse.pvs
      • EquinioxBMS
        • EquinioxBMS.CURTIME
        • EquinioxBMS.DATATIME
        • EquinioxBMS.DEVICE_TYPE
        • EquinioxBMS.HWVER
        • EquinioxBMS.ISDETAIL
        • EquinioxBMS.MODEL
        • EquinioxBMS.OPERATION
        • EquinioxBMS.PARENT
        • EquinioxBMS.PORT
        • EquinioxBMS.SERIAL
        • EquinioxBMS.STATE
        • EquinioxBMS.STATEDESCR
        • EquinioxBMS.SWVER
        • EquinioxBMS.TYPE
        • EquinioxBMS.interface
        • EquinioxBMS.mac_address
        • EquinioxBMS.origin
        • EquinioxBMS.panid
        • EquinioxBMS.parent
        • EquinioxBMS.slave
        • EquinioxBMS.construct
        • EquinioxBMS.model_copy
        • EquinioxBMS.model_validate
        • EquinioxBMS.model_validate_json
        • EquinioxBMS.model_validate_strings
        • EquinioxBMS.parse_file
        • EquinioxBMS.parse_obj
        • EquinioxBMS.parse_raw
        • EquinioxBMS.parse_timestamp
      • EquinoxESS
        • EquinoxESS.CURTIME
        • EquinoxESS.DATATIME
        • EquinoxESS.DESCR
        • EquinoxESS.DEVICE_TYPE
        • EquinoxESS.HWVER
        • EquinoxESS.ISDETAIL
        • EquinoxESS.MODEL
        • EquinoxESS.OPERATION
        • EquinoxESS.PORT
        • EquinoxESS.SERIAL
        • EquinoxESS.STATE
        • EquinoxESS.STATEDESCR
        • EquinoxESS.SWVER
        • EquinoxESS.TYPE
        • EquinoxESS.hw_version
        • EquinoxESS.interface
        • EquinoxESS.origin
        • EquinoxESS.panid
        • EquinoxESS.construct
        • EquinoxESS.model_copy
        • EquinoxESS.model_validate
        • EquinoxESS.model_validate_json
        • EquinoxESS.model_validate_strings
        • EquinoxESS.parse_file
        • EquinoxESS.parse_obj
        • EquinoxESS.parse_raw
        • EquinoxESS.parse_timestamp
      • Gateway
        • Gateway.CURTIME
        • Gateway.DATATIME
        • Gateway.DEVICE_TYPE
        • Gateway.HWVER
        • Gateway.ISDETAIL
        • Gateway.MODEL
        • Gateway.OPERATION
        • Gateway.PORT
        • Gateway.SERIAL
        • Gateway.STATE
        • Gateway.STATEDESCR
        • Gateway.SWVER
        • Gateway.TYPE
        • Gateway.interface
        • Gateway.mac_address
        • Gateway.origin
        • Gateway.panid
        • Gateway.slave
        • Gateway.construct
        • Gateway.model_copy
        • Gateway.model_validate
        • Gateway.model_validate_json
        • Gateway.model_validate_strings
        • Gateway.parse_file
        • Gateway.parse_obj
        • Gateway.parse_raw
        • Gateway.parse_timestamp
      • PVDisconnectDetail
        • PVDisconnectDetail.CURTIME
        • PVDisconnectDetail.DATATIME
        • PVDisconnectDetail.DEVICE_TYPE
        • PVDisconnectDetail.HWVER
        • PVDisconnectDetail.ISDETAIL
        • PVDisconnectDetail.MODEL
        • PVDisconnectDetail.OPERATION
        • PVDisconnectDetail.PORT
        • PVDisconnectDetail.SERIAL
        • PVDisconnectDetail.STATE
        • PVDisconnectDetail.STATEDESCR
        • PVDisconnectDetail.SWVER
        • PVDisconnectDetail.TYPE
        • PVDisconnectDetail.event_history
        • PVDisconnectDetail.fw_error
        • PVDisconnectDetail.hw_version
        • PVDisconnectDetail.interface
        • PVDisconnectDetail.origin
        • PVDisconnectDetail.panid
        • PVDisconnectDetail.relay1_error
        • PVDisconnectDetail.relay1_state
        • PVDisconnectDetail.relay2_error
        • PVDisconnectDetail.relay2_state
        • PVDisconnectDetail.relay_mode
        • PVDisconnectDetail.slave
        • PVDisconnectDetail.v1n_grid_v
        • PVDisconnectDetail.v1n_pv_v
        • PVDisconnectDetail.v2n_grid_v
        • PVDisconnectDetail.v2n_pv_v
        • PVDisconnectDetail.construct
        • PVDisconnectDetail.model_copy
        • PVDisconnectDetail.model_validate
        • PVDisconnectDetail.model_validate_json
        • PVDisconnectDetail.model_validate_strings
        • PVDisconnectDetail.parse_file
        • PVDisconnectDetail.parse_integer_fields
        • PVDisconnectDetail.parse_obj
        • PVDisconnectDetail.parse_raw
        • PVDisconnectDetail.parse_timestamp
      • PVSDeviceDetail
        • PVSDeviceDetail.CURTIME
        • PVSDeviceDetail.DATATIME
        • PVSDeviceDetail.DEVICE_TYPE
        • PVSDeviceDetail.HWVER
        • PVSDeviceDetail.ISDETAIL
        • PVSDeviceDetail.MODEL
        • PVSDeviceDetail.OPERATION
        • PVSDeviceDetail.PORT
        • PVSDeviceDetail.SERIAL
        • PVSDeviceDetail.STATE
        • PVSDeviceDetail.STATEDESCR
        • PVSDeviceDetail.SWVER
        • PVSDeviceDetail.TYPE
        • PVSDeviceDetail.dl_comm_err
        • PVSDeviceDetail.dl_cpu_load
        • PVSDeviceDetail.dl_error_count
        • PVSDeviceDetail.dl_flash_avail
        • PVSDeviceDetail.dl_mem_used
        • PVSDeviceDetail.dl_scan_time
        • PVSDeviceDetail.dl_skipped_scans
        • PVSDeviceDetail.dl_untransmitted
        • PVSDeviceDetail.dl_uptime
        • PVSDeviceDetail.origin
        • PVSDeviceDetail.panid
        • PVSDeviceDetail.construct
        • PVSDeviceDetail.model_copy
        • PVSDeviceDetail.model_validate
        • PVSDeviceDetail.model_validate_json
        • PVSDeviceDetail.model_validate_strings
        • PVSDeviceDetail.parse_file
        • PVSDeviceDetail.parse_obj
        • PVSDeviceDetail.parse_raw
        • PVSDeviceDetail.parse_timestamp
        • PVSDeviceDetail.last_restart_time
      • PowerMeterDeviceDetail
        • PowerMeterDeviceDetail.CAL0
        • PowerMeterDeviceDetail.CURTIME
        • PowerMeterDeviceDetail.DATATIME
        • PowerMeterDeviceDetail.DEVICE_TYPE
        • PowerMeterDeviceDetail.HWVER
        • PowerMeterDeviceDetail.ISDETAIL
        • PowerMeterDeviceDetail.MODEL
        • PowerMeterDeviceDetail.OPERATION
        • PowerMeterDeviceDetail.PORT
        • PowerMeterDeviceDetail.SERIAL
        • PowerMeterDeviceDetail.STATE
        • PowerMeterDeviceDetail.STATEDESCR
        • PowerMeterDeviceDetail.SWVER
        • PowerMeterDeviceDetail.TYPE
        • PowerMeterDeviceDetail.ct_scl_fctr
        • PowerMeterDeviceDetail.freq_hz
        • PowerMeterDeviceDetail.interface
        • PowerMeterDeviceDetail.net_ltea_3phsum_kwh
        • PowerMeterDeviceDetail.origin
        • PowerMeterDeviceDetail.p_3phsum_kw
        • PowerMeterDeviceDetail.panid
        • PowerMeterDeviceDetail.q_3phsum_kvar
        • PowerMeterDeviceDetail.s_3phsum_kva
        • PowerMeterDeviceDetail.subtype
        • PowerMeterDeviceDetail.tot_pf_rto
        • PowerMeterDeviceDetail.v12_v
        • PowerMeterDeviceDetail.construct
        • PowerMeterDeviceDetail.model_copy
        • PowerMeterDeviceDetail.model_validate
        • PowerMeterDeviceDetail.model_validate_json
        • PowerMeterDeviceDetail.model_validate_strings
        • PowerMeterDeviceDetail.parse_file
        • PowerMeterDeviceDetail.parse_obj
        • PowerMeterDeviceDetail.parse_raw
        • PowerMeterDeviceDetail.parse_timestamp
      • ProductionPowerMeterDeviceDetail
        • ProductionPowerMeterDeviceDetail.CAL0
        • ProductionPowerMeterDeviceDetail.CURTIME
        • ProductionPowerMeterDeviceDetail.DATATIME
        • ProductionPowerMeterDeviceDetail.DEVICE_TYPE
        • ProductionPowerMeterDeviceDetail.HWVER
        • ProductionPowerMeterDeviceDetail.ISDETAIL
        • ProductionPowerMeterDeviceDetail.MODEL
        • ProductionPowerMeterDeviceDetail.OPERATION
        • ProductionPowerMeterDeviceDetail.PORT
        • ProductionPowerMeterDeviceDetail.SERIAL
        • ProductionPowerMeterDeviceDetail.STATE
        • ProductionPowerMeterDeviceDetail.STATEDESCR
        • ProductionPowerMeterDeviceDetail.SWVER
        • ProductionPowerMeterDeviceDetail.TYPE
        • ProductionPowerMeterDeviceDetail.ct_scl_fctr
        • ProductionPowerMeterDeviceDetail.freq_hz
        • ProductionPowerMeterDeviceDetail.i_a
        • ProductionPowerMeterDeviceDetail.interface
        • ProductionPowerMeterDeviceDetail.net_ltea_3phsum_kwh
        • ProductionPowerMeterDeviceDetail.origin
        • ProductionPowerMeterDeviceDetail.p_3phsum_kw
        • ProductionPowerMeterDeviceDetail.panid
        • ProductionPowerMeterDeviceDetail.production_subtype_enum
        • ProductionPowerMeterDeviceDetail.q_3phsum_kvar
        • ProductionPowerMeterDeviceDetail.s_3phsum_kva
        • ProductionPowerMeterDeviceDetail.subtype
        • ProductionPowerMeterDeviceDetail.tot_pf_rto
        • ProductionPowerMeterDeviceDetail.v12_v
        • ProductionPowerMeterDeviceDetail.construct
        • ProductionPowerMeterDeviceDetail.model_copy
        • ProductionPowerMeterDeviceDetail.model_validate
        • ProductionPowerMeterDeviceDetail.model_validate_json
        • ProductionPowerMeterDeviceDetail.model_validate_strings
        • ProductionPowerMeterDeviceDetail.parse_file
        • ProductionPowerMeterDeviceDetail.parse_obj
        • ProductionPowerMeterDeviceDetail.parse_raw
        • ProductionPowerMeterDeviceDetail.parse_timestamp
      • SchneiderXwPro
        • SchneiderXwPro.CURTIME
        • SchneiderXwPro.DATATIME
        • SchneiderXwPro.DEVICE_TYPE
        • SchneiderXwPro.HWVER
        • SchneiderXwPro.ISDETAIL
        • SchneiderXwPro.MODEL
        • SchneiderXwPro.OPERATION
        • SchneiderXwPro.PARENT
        • SchneiderXwPro.PORT
        • SchneiderXwPro.SERIAL
        • SchneiderXwPro.STATE
        • SchneiderXwPro.STATEDESCR
        • SchneiderXwPro.SWVER
        • SchneiderXwPro.TYPE
        • SchneiderXwPro.interface
        • SchneiderXwPro.mac_address
        • SchneiderXwPro.origin
        • SchneiderXwPro.panid
        • SchneiderXwPro.parent
        • SchneiderXwPro.slave
        • SchneiderXwPro.construct
        • SchneiderXwPro.model_copy
        • SchneiderXwPro.model_validate
        • SchneiderXwPro.model_validate_json
        • SchneiderXwPro.model_validate_strings
        • SchneiderXwPro.parse_file
        • SchneiderXwPro.parse_obj
        • SchneiderXwPro.parse_raw
        • SchneiderXwPro.parse_timestamp
      • SolarBridgeDeviceDetail
        • SolarBridgeDeviceDetail.CURTIME
        • SolarBridgeDeviceDetail.DATATIME
        • SolarBridgeDeviceDetail.DEVICE_TYPE
        • SolarBridgeDeviceDetail.HWVER
        • SolarBridgeDeviceDetail.ISDETAIL
        • SolarBridgeDeviceDetail.MODEL
        • SolarBridgeDeviceDetail.MOD_SN
        • SolarBridgeDeviceDetail.NMPLT_SKU
        • SolarBridgeDeviceDetail.OPERATION
        • SolarBridgeDeviceDetail.PANEL
        • SolarBridgeDeviceDetail.PORT
        • SolarBridgeDeviceDetail.SERIAL
        • SolarBridgeDeviceDetail.STATE
        • SolarBridgeDeviceDetail.STATEDESCR
        • SolarBridgeDeviceDetail.SWVER
        • SolarBridgeDeviceDetail.TYPE
        • SolarBridgeDeviceDetail.freq_hz
        • SolarBridgeDeviceDetail.hw_version
        • SolarBridgeDeviceDetail.i_3phsum_a
        • SolarBridgeDeviceDetail.i_mppt1_a
        • SolarBridgeDeviceDetail.interface
        • SolarBridgeDeviceDetail.ltea_3phsum_kwh
        • SolarBridgeDeviceDetail.module_serial
        • SolarBridgeDeviceDetail.origin
        • SolarBridgeDeviceDetail.p_3phsum_kw
        • SolarBridgeDeviceDetail.p_mppt1_v
        • SolarBridgeDeviceDetail.p_mpptsum_kw
        • SolarBridgeDeviceDetail.panid
        • SolarBridgeDeviceDetail.slave
        • SolarBridgeDeviceDetail.stat_ind
        • SolarBridgeDeviceDetail.t_htsink_degc
        • SolarBridgeDeviceDetail.v_mppt1_v
        • SolarBridgeDeviceDetail.vln_3phsum_v
        • SolarBridgeDeviceDetail.construct
        • SolarBridgeDeviceDetail.model_copy
        • SolarBridgeDeviceDetail.model_validate
        • SolarBridgeDeviceDetail.model_validate_json
        • SolarBridgeDeviceDetail.model_validate_strings
        • SolarBridgeDeviceDetail.parse_file
        • SolarBridgeDeviceDetail.parse_obj
        • SolarBridgeDeviceDetail.parse_raw
        • SolarBridgeDeviceDetail.parse_timestamp
      • DeviceClass
    • Firmware
      • CheckFWResponse
        • CheckFWResponse.url
        • CheckFWResponse.construct
        • CheckFWResponse.model_construct
        • CheckFWResponse.model_copy
        • CheckFWResponse.model_dump
        • CheckFWResponse.model_dump_json
        • CheckFWResponse.model_validate
        • CheckFWResponse.model_validate_json
        • CheckFWResponse.model_validate_strings
        • CheckFWResponse.parse_file
        • CheckFWResponse.parse_obj
        • CheckFWResponse.parse_raw
        • CheckFWResponse.parse_url
    • Grid
      • GridProfile
        • GridProfile.default
        • GridProfile.filename
        • GridProfile.id
        • GridProfile.name
        • GridProfile.selfsupply
        • GridProfile.zipcodes
        • GridProfile.construct
        • GridProfile.model_construct
        • GridProfile.model_copy
        • GridProfile.model_dump
        • GridProfile.model_dump_json
        • GridProfile.model_validate
        • GridProfile.model_validate_json
        • GridProfile.model_validate_strings
        • GridProfile.parse_file
        • GridProfile.parse_obj
        • GridProfile.parse_raw
      • GridProfileGetResponse
        • GridProfileGetResponse.active_id
        • GridProfileGetResponse.active_name
        • GridProfileGetResponse.pending_id
        • GridProfileGetResponse.pending_name
        • GridProfileGetResponse.percent
        • GridProfileGetResponse.result
        • GridProfileGetResponse.status
        • GridProfileGetResponse.supported_by
        • GridProfileGetResponse.construct
        • GridProfileGetResponse.model_construct
        • GridProfileGetResponse.model_copy
        • GridProfileGetResponse.model_dump
        • GridProfileGetResponse.model_dump_json
        • GridProfileGetResponse.model_validate
        • GridProfileGetResponse.model_validate_json
        • GridProfileGetResponse.model_validate_strings
        • GridProfileGetResponse.parse_file
        • GridProfileGetResponse.parse_obj
        • GridProfileGetResponse.parse_raw
      • GridProfileRefreshResponse
        • GridProfileRefreshResponse.creation
        • GridProfileRefreshResponse.profiles
        • GridProfileRefreshResponse.result
        • GridProfileRefreshResponse.success
        • GridProfileRefreshResponse.construct
        • GridProfileRefreshResponse.model_construct
        • GridProfileRefreshResponse.model_copy
        • GridProfileRefreshResponse.model_dump
        • GridProfileRefreshResponse.model_dump_json
        • GridProfileRefreshResponse.model_validate
        • GridProfileRefreshResponse.model_validate_json
        • GridProfileRefreshResponse.model_validate_strings
        • GridProfileRefreshResponse.parse_creation_timestamp
        • GridProfileRefreshResponse.parse_file
        • GridProfileRefreshResponse.parse_obj
        • GridProfileRefreshResponse.parse_raw
      • Zipcode
        • Zipcode.max
        • Zipcode.min
        • Zipcode.construct
        • Zipcode.model_construct
        • Zipcode.model_copy
        • Zipcode.model_dump
        • Zipcode.model_dump_json
        • Zipcode.model_validate
        • Zipcode.model_validate_json
        • Zipcode.model_validate_strings
        • Zipcode.parse_file
        • Zipcode.parse_obj
        • Zipcode.parse_raw
    • Network
      • GetCommResponse
        • GetCommResponse.networkstatus
        • GetCommResponse.result
        • GetCommResponse.construct
        • GetCommResponse.model_construct
        • GetCommResponse.model_copy
        • GetCommResponse.model_dump
        • GetCommResponse.model_dump_json
        • GetCommResponse.model_validate
        • GetCommResponse.model_validate_json
        • GetCommResponse.model_validate_strings
        • GetCommResponse.parse_file
        • GetCommResponse.parse_obj
        • GetCommResponse.parse_raw
      • Interface
        • Interface.interface
        • Interface.internet
        • Interface.ipaddr
        • Interface.is_always_on
        • Interface.is_primary
        • Interface.link
        • Interface.mode
        • Interface.modem
        • Interface.pairing
        • Interface.provider
        • Interface.sim
        • Interface.sms
        • Interface.speed
        • Interface.ssid
        • Interface.state
        • Interface.status
        • Interface.construct
        • Interface.model_construct
        • Interface.model_copy
        • Interface.model_dump
        • Interface.model_dump_json
        • Interface.model_validate
        • Interface.model_validate_json
        • Interface.model_validate_strings
        • Interface.parse_file
        • Interface.parse_ipaddr
        • Interface.parse_obj
        • Interface.parse_raw
      • NetworkStatus
        • NetworkStatus.interfaces
        • NetworkStatus.system
        • NetworkStatus.ts
        • NetworkStatus.construct
        • NetworkStatus.model_construct
        • NetworkStatus.model_copy
        • NetworkStatus.model_dump
        • NetworkStatus.model_dump_json
        • NetworkStatus.model_validate
        • NetworkStatus.model_validate_json
        • NetworkStatus.model_validate_strings
        • NetworkStatus.parse_file
        • NetworkStatus.parse_obj
        • NetworkStatus.parse_raw
      • System
        • System.interface
        • System.internet
        • System.sms
        • System.construct
        • System.model_construct
        • System.model_copy
        • System.model_dump
        • System.model_dump_json
        • System.model_validate
        • System.model_validate_json
        • System.model_validate_strings
        • System.parse_file
        • System.parse_obj
        • System.parse_raw
    • Session
      • StartResponse
        • StartResponse.result
        • StartResponse.supervisor
        • StartResponse.construct
        • StartResponse.model_construct
        • StartResponse.model_copy
        • StartResponse.model_dump
        • StartResponse.model_dump_json
        • StartResponse.model_validate
        • StartResponse.model_validate_json
        • StartResponse.model_validate_strings
        • StartResponse.parse_file
        • StartResponse.parse_obj
        • StartResponse.parse_raw
      • StopResponse
        • StopResponse.result
        • StopResponse.construct
        • StopResponse.model_construct
        • StopResponse.model_copy
        • StopResponse.model_dump
        • StopResponse.model_dump_json
        • StopResponse.model_validate
        • StopResponse.model_validate_json
        • StopResponse.model_validate_strings
        • StopResponse.parse_file
        • StopResponse.parse_obj
        • StopResponse.parse_raw
      • Supervisor
        • Supervisor.BUILD
        • Supervisor.EASICVER
        • Supervisor.FWVER
        • Supervisor.MODEL
        • Supervisor.SCBUILD
        • Supervisor.SCVER
        • Supervisor.SERIAL
        • Supervisor.SWVER
        • Supervisor.WNMODEL
        • Supervisor.WNSERIAL
        • Supervisor.WNVER
        • Supervisor.construct
        • Supervisor.model_construct
        • Supervisor.model_copy
        • Supervisor.model_dump
        • Supervisor.model_dump_json
        • Supervisor.model_validate
        • Supervisor.model_validate_json
        • Supervisor.model_validate_strings
        • Supervisor.parse_file
        • Supervisor.parse_obj
        • Supervisor.parse_raw
  • Client API Reference
    • SungazerClient
      • SungazerClient
        • SungazerClient.close
    • BaseClient
      • BaseClient
    • SessionClient
      • SessionClient
        • SessionClient.start
        • SessionClient.stop
    • NetworkClient
      • NetworkClient
        • NetworkClient.list
    • DeviceClient
      • DeviceClient
        • DeviceClient.list
    • FirmwareClient
      • FirmwareClient
        • FirmwareClient.check
    • GridProfileClient
      • GridProfileClient
        • GridProfileClient.get
        • GridProfileClient.refresh
    • Usage Examples
      • Basic Client Usage
      • Context Manager Usage
      • Session Management
      • Device Operations
      • Network Operations
      • Firmware Operations
      • Grid Profile Operations
    • Error Handling
      • HTTP Errors
      • Session Errors
    • Advanced Usage
      • Custom HTTP Client
      • Retry Logic
      • Data Processing
      • Monitoring Script
      • Data Collection
    • Best Practices
      • Session Management
      • Resource Management
      • Error Recovery
    • Performance Considerations
      • Connection Reuse
      • Timeout Configuration
      • SSL Configuration
    • API Reference Details
      • Method Parameters
      • Return Types
      • Error Types

Runbook

  • Contributing
    • Instructions for contributors
    • Preconditions for working on this project
      • Python environment
    • Testing out sungazer
    • Updating the documentation
      • doc/source/index.rst
      • autodoc
      • etc.
    • Releasing the code to PyPI
sungazer
  • Search

© Copyright Christopher Malek 2025.