Class ComfortCloudClient
- Namespace
- PanasonicComfortCloudClient
- Assembly
- PanasonicComfortCloudClient.dll
Provides serialized, cancellable access to Panasonic Comfort Cloud without platform-specific dependencies.
public sealed class ComfortCloudClient : IDisposable
- Inheritance
-
ComfortCloudClient
- Implements
- Inherited Members
Remarks
Concurrent operations are serialized, including compound read/modify/write helpers. Disposal rejects new operations and cancels admitted work; owned transport resources are released after that work exits. Owns in-memory session state only. Storage, browser presentation and polling schedules belong to the application.
Constructors
ComfortCloudClient(ComfortCloudOptions, HttpClient?)
Creates a cloud client without sending any requests.
public ComfortCloudClient(ComfortCloudOptions options, HttpClient? httpClient = null)
Parameters
optionsComfortCloudOptionsProtocol identity, pacing, timeouts and optional logging.
httpClientHttpClientAn optional application-owned client; its handler must disable automatic redirects.
Properties
AppVersion
Gets the current explicitly selected official app version.
public string AppVersion { get; }
Property Value
- string
The protocol version advertised on subsequent requests.
CurrentSession
Gets the latest validated in-memory credential snapshot.
public ComfortCloudSession? CurrentSession { get; }
Property Value
- ComfortCloudSession
The current credentials, or null before authentication; the caller owns persistence.
Methods
AcceptAgreementsAsync(IReadOnlyList<AgreementAcceptance>, CancellationToken)
Accepts only the exact policy versions explicitly supplied by the application.
public Task AcceptAgreementsAsync(IReadOnlyList<AgreementAcceptance> agreements, CancellationToken cancellationToken = default)
Parameters
agreementsIReadOnlyList<AgreementAcceptance>The type/version pairs reviewed and accepted by the account owner.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task
A task completing when the cloud acknowledges acceptance.
Remarks
No policy is accepted automatically during authentication or other API operations.
AcceptLegacyAgreementAsync(int, CancellationToken)
Explicitly calls the retired v1 agreement-acceptance route.
public Task AcceptLegacyAgreementAsync(int agreementType, CancellationToken cancellationToken = default)
Parameters
agreementTypeintThe positive policy type the account owner elected to accept.
cancellationTokenCancellationTokenCancels the request.
Returns
- Task
A task completing on acknowledgement; route errors are propagated without fallback to v2.
AuthenticateWithPasswordAsync(string, string, CancellationToken)
Runs the upstream username/password form protocol without opening a browser.
public Task<LegacyAuthenticationResult> AuthenticateWithPasswordAsync(string userName, string password, CancellationToken cancellationToken = default)
Parameters
userNamestringThe Panasonic ID user name; never logged or persisted.
passwordstringThe password, supplied in memory and never retained by the client.
cancellationTokenCancellationTokenCancels the bounded authentication requests.
Returns
- Task<LegacyAuthenticationResult>
Registered credentials or a pending MFA challenge. Existing credentials are retained until a new token response validates.
CompleteAuthorizationAsync(OAuthAuthorizationRequest, Uri, CancellationToken)
Validates a Panasonic browser callback, exchanges its code and registers the cloud client.
public Task<ComfortCloudSession> CompleteAuthorizationAsync(OAuthAuthorizationRequest authorization, Uri callbackUri, CancellationToken cancellationToken = default)
Parameters
authorizationOAuthAuthorizationRequestThe securely retained context for this one-use attempt.
callbackUriUriThe complete Panasonic custom-scheme callback, including code and matching state.
cancellationTokenCancellationTokenCancels waiting, token exchange or registration.
Returns
- Task<ComfortCloudSession>
The validated credential snapshot; no file is written by the library.
CompletePasswordMfaAsync(LegacyMfaChallenge, string, CancellationToken)
Completes a pending classic OTP or Guardian challenge once.
public Task<ComfortCloudSession> CompletePasswordMfaAsync(LegacyMfaChallenge challenge, string oneTimePassword, CancellationToken cancellationToken = default)
Parameters
challengeLegacyMfaChallengeThe challenge returned by this client's current password attempt.
oneTimePasswordstringThe current authenticator code; never logged or persisted.
cancellationTokenCancellationTokenCancels negotiation, polling, token exchange or registration.
Returns
- Task<ComfortCloudSession>
The registered credential snapshot.
CreateAuthorizationRequest()
Creates a PKCE login attempt without opening a browser or sending a request.
public OAuthAuthorizationRequest CreateAuthorizationRequest()
Returns
- OAuthAuthorizationRequest
A one-use authorization context; the application presents its URL and retains the verifier securely.
Dispose()
Cancels outstanding client work and releases an internally created HTTP client.
public void Dispose()
Remarks
An injected HTTP client remains owned by the application. Disposal does not log out or delete tokens, wait synchronously for operations, or dispose resources still used by admitted work. A response that ignores cancellation cannot publish a new session after disposal.
EnsureAgreementsAcceptedAsync(int, CancellationToken)
Explicitly accepts all currently pending generally applicable policies, matching the upstream convenience operation.
public Task EnsureAgreementsAcceptedAsync(int language = 0, CancellationToken cancellationToken = default)
Parameters
languageintThe policy language identifier.
cancellationTokenCancellationTokenCancels the reads or acceptance request.
Returns
- Task
A task completing when no applicable policies remain to submit or the exact reported versions are acknowledged.
Remarks
This is an account-changing operation. Call only after the account owner has authorized acceptance. Login never invokes it automatically.
GetAcDailyEnergyAsync(string, DateTime, TimeSpan, CancellationToken)
Fetches the requested date's AC daily total from monthly history.
public Task<AcEnergyHistoryEntry?> GetAcDailyEnergyAsync(string deviceGuid, DateTime date, TimeSpan utcOffset, CancellationToken cancellationToken = default)
Parameters
deviceGuidstringThe discovered device GUID.
dateDateTimeThe device-local calendar date; the caller selects today if wanted.
utcOffsetTimeSpanThe UTC offset applicable to this device and period.
cancellationTokenCancellationTokenCancels the request.
Returns
- Task<AcEnergyHistoryEntry>
The matching daily entry, or null when the cloud has no entry yet.
GetAcEnergyAsync(string, AcEnergyPeriod, DateTime, TimeSpan, CancellationToken)
Fetches air-conditioner energy history using AC-specific period values.
public Task<IReadOnlyList<AcEnergyHistoryEntry>> GetAcEnergyAsync(string deviceGuid, AcEnergyPeriod period, DateTime date, TimeSpan utcOffset, CancellationToken cancellationToken = default)
Parameters
deviceGuidstringThe discovered device GUID.
periodAcEnergyPeriodThe AC day/week/month/year period.
dateDateTimeThe date selecting the period.
utcOffsetTimeSpanThe UTC offset sent as osTimezone, in whole minutes between minus and plus fourteen hours.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<IReadOnlyList<AcEnergyHistoryEntry>>
The reported history entries.
GetAcScheduleAsync(string, CancellationToken)
Reads the complete weekly schedule of an air conditioner.
public Task<AcSchedule?> GetAcScheduleAsync(string deviceGuid, CancellationToken cancellationToken = default)
Parameters
deviceGuidstringThe discovered device GUID.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<AcSchedule>
The device schedule, or null when the service explicitly returns no schedule.
GetAcStatusAsync(string, StatusSource, CancellationToken)
Fetches air-conditioner state without silently falling back to cached data.
public Task<AcSnapshot> GetAcStatusAsync(string deviceGuid, StatusSource source = StatusSource.Live, CancellationToken cancellationToken = default)
Parameters
deviceGuidstringThe discovered device GUID.
sourceStatusSourceLive or explicitly cached status.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<AcSnapshot>
The typed device status; missing parameters are an error.
GetAgreementDocumentsAsync(bool, int, CancellationToken)
Reads Panasonic policy documents without accepting them.
public Task<IReadOnlyList<AgreementDocument>> GetAgreementDocumentsAsync(bool includeContent = false, int language = 0, CancellationToken cancellationToken = default)
Parameters
includeContentboolWhether to include the policy text.
languageintThe API language identifier; zero is the default language.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<IReadOnlyList<AgreementDocument>>
The policy documents reported by the v2 agreement endpoint.
GetAgreementDocumentsAsync(int, bool, int, CancellationToken)
Reads current agreement documents for one type.
public Task<IReadOnlyList<AgreementDocument>> GetAgreementDocumentsAsync(int agreementType, bool includeContent = false, int language = 0, CancellationToken cancellationToken = default)
Parameters
agreementTypeintThe positive policy type to select.
includeContentboolWhether to retrieve the document text.
languageintThe API language identifier.
cancellationTokenCancellationTokenCancels the read.
Returns
- Task<IReadOnlyList<AgreementDocument>>
The filtered document list; nothing is accepted.
GetAgreementStatusAsync(int, CancellationToken)
Reads accepted versions for one agreement type.
public Task<IReadOnlyList<AgreementAcceptance>> GetAgreementStatusAsync(int agreementType, CancellationToken cancellationToken = default)
Parameters
agreementTypeintThe positive policy type to select.
cancellationTokenCancellationTokenCancels the read.
Returns
- Task<IReadOnlyList<AgreementAcceptance>>
The account's reported accepted versions.
GetAgreementStatusAsync(CancellationToken)
Reads the policy versions already accepted by the account.
public Task<IReadOnlyList<AgreementAcceptance>> GetAgreementStatusAsync(CancellationToken cancellationToken = default)
Parameters
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<IReadOnlyList<AgreementAcceptance>>
The explicitly accepted type/version pairs.
GetAquareaEnergyAsync(string, EnergyPeriod, DateTime, TimeSpan, CancellationToken)
Fetches Aquarea energy and cost history through its dedicated proxy endpoint.
public Task<IReadOnlyList<EnergyHistoryEntry>> GetAquareaEnergyAsync(string gatewayId, EnergyPeriod period, DateTime date, TimeSpan utcOffset, CancellationToken cancellationToken = default)
Parameters
gatewayIdstringThe discovered Aquarea device GUID.
periodEnergyPeriodDay, month or year; AC history uses a different enum.
dateDateTimeThe date selecting the requested period.
utcOffsetTimeSpanThe UTC offset sent as osTimezone, in whole minutes between minus and plus fourteen hours.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<IReadOnlyList<EnergyHistoryEntry>>
The reported entries; absent history is an error, while an explicit empty list is preserved.
GetAquareaScheduleAsync(string, CancellationToken)
Reads an Aquarea weekly schedule and the accompanying limits.
public Task<AquareaSchedule> GetAquareaScheduleAsync(string gatewayId, CancellationToken cancellationToken = default)
Parameters
gatewayIdstringThe Aquarea gateway GUID.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<AquareaSchedule>
The typed complete schedule; unrecognized fields are retained for round trips.
GetAquareaStatusAsync(string, StatusSource, CancellationToken)
Fetches Aquarea status using the current transfer-proxy API.
public Task<AquareaSnapshot> GetAquareaStatusAsync(string gatewayId, StatusSource source = StatusSource.Live, CancellationToken cancellationToken = default)
Parameters
gatewayIdstringThe discovered Aquarea device GUID.
sourceStatusSourceWhether to request live or explicitly cached status; no fallback is performed.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<AquareaSnapshot>
A complete typed response labelled with its requested source and receipt time.
GetDevicesAsync(DeviceFamily?, CancellationToken)
Discovers devices, optionally filtering by the modeled API family.
public Task<IReadOnlyList<DeviceInfo>> GetDevicesAsync(DeviceFamily? family = null, CancellationToken cancellationToken = default)
Parameters
familyDeviceFamily?The family to select, or null for all devices including unknown types.
cancellationTokenCancellationTokenCancels discovery.
Returns
- Task<IReadOnlyList<DeviceInfo>>
The flattened current group listing.
GetGroupsAsync(CancellationToken)
Fetches groups and their device descriptions from Comfort Cloud.
public Task<IReadOnlyList<ComfortCloudGroup>> GetGroupsAsync(CancellationToken cancellationToken = default)
Parameters
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<IReadOnlyList<ComfortCloudGroup>>
The reported groups; a missing group list is an error rather than an empty discovery result.
GetHotWaterDailyEnergyAsync(string, DateTime, TimeSpan, CancellationToken)
Fetches the requested date's HWS daily total from monthly history.
public Task<HotWaterEnergyHistoryEntry?> GetHotWaterDailyEnergyAsync(string deviceGuid, DateTime date, TimeSpan utcOffset, CancellationToken cancellationToken = default)
Parameters
deviceGuidstringThe discovered device GUID.
dateDateTimeThe device-local calendar date.
utcOffsetTimeSpanThe UTC offset applicable to the device and period.
cancellationTokenCancellationTokenCancels the request.
Returns
- Task<HotWaterEnergyHistoryEntry>
The daily entry, or null when no matching entry is reported.
GetHotWaterEnergyAsync(string, EnergyPeriod, DateTime, TimeSpan, CancellationToken)
Fetches standalone HWS energy history.
public Task<IReadOnlyList<HotWaterEnergyHistoryEntry>> GetHotWaterEnergyAsync(string deviceGuid, EnergyPeriod period, DateTime date, TimeSpan utcOffset, CancellationToken cancellationToken = default)
Parameters
deviceGuidstringThe discovered HWS device GUID.
periodEnergyPeriodThe HWS day/month/year period.
dateDateTimeThe date selecting the period.
utcOffsetTimeSpanThe UTC offset sent as osTimezone, in whole minutes between minus and plus fourteen hours.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<IReadOnlyList<HotWaterEnergyHistoryEntry>>
The reported HWS history entries.
GetHotWaterStatusAsync(string, CancellationToken)
Fetches standalone heat-pump hot-water status from its dedicated endpoint.
public Task<HotWaterSnapshot> GetHotWaterStatusAsync(string deviceGuid, CancellationToken cancellationToken = default)
Parameters
deviceGuidstringThe discovered HWS device GUID.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task<HotWaterSnapshot>
The typed HWS status; AC endpoints are not used for HWS devices.
GetLegacyAgreementStatusAsync(int, CancellationToken)
Calls the retained legacy v1 agreement-status route.
public Task<int?> GetLegacyAgreementStatusAsync(int agreementType, CancellationToken cancellationToken = default)
Parameters
agreementTypeintThe positive policy type.
cancellationTokenCancellationTokenCancels the request.
Returns
- Task<int?>
The reported status, or null when absent. Upstream reports that the retired route normally returns 403.
GetLegacyAquareaAsync<TResponse>(string, IReadOnlyDictionary<string, string>?, CancellationToken)
Reads a legacy Aquarea cookie-authenticated endpoint into an explicit response model.
public Task<TResponse> GetLegacyAquareaAsync<TResponse>(string relativePath, IReadOnlyDictionary<string, string>? cookies = null, CancellationToken cancellationToken = default) where TResponse : class
Parameters
relativePathstringThe path within the configured Aquarea web origin.
cookiesIReadOnlyDictionary<string, string>Optional application-owned cookies; the current access-token cookie is supplied by the library.
cancellationTokenCancellationTokenCancels waiting, refresh or retrieval.
Returns
- Task<TResponse>
The modeled response; cookies are isolated from the identity and Comfort Cloud services.
Type Parameters
TResponseThe attribute-defined response type expected from that endpoint.
GetLegacyAquareaPageAsync(string, IReadOnlyDictionary<string, string>?, CancellationToken)
Reads an HTML page from the separate cookie-authenticated legacy Aquarea site.
public Task<string> GetLegacyAquareaPageAsync(string relativePath, IReadOnlyDictionary<string, string>? cookies = null, CancellationToken cancellationToken = default)
Parameters
relativePathstringThe path within the configured Aquarea origin.
cookiesIReadOnlyDictionary<string, string>Additional non-token cookies.
cancellationTokenCancellationTokenCancels waiting, refresh or retrieval.
Returns
- Task<string>
The HTML page text. JSON endpoints should use an explicit model with the generic overload.
GetPendingAgreementsAsync(bool, int, CancellationToken)
Finds outdated or unaccepted generally applicable policies.
public Task<IReadOnlyList<AgreementDocument>> GetPendingAgreementsAsync(bool includeContent = false, int language = 0, CancellationToken cancellationToken = default)
Parameters
includeContentboolWhether to include text for application presentation.
languageintThe policy language identifier.
cancellationTokenCancellationTokenCancels document/status reads.
Returns
- Task<IReadOnlyList<AgreementDocument>>
Pending types one, two and four; the Turkey-only service policy is excluded as upstream specifies.
LogoutAsync(CancellationToken)
Explicitly logs out the cloud session and clears only the in-memory credentials.
public Task LogoutAsync(CancellationToken cancellationToken = default)
Parameters
cancellationTokenCancellationTokenCancels waiting or logout.
Returns
- Task
A task completing after the cloud accepts logout.
PostLegacyAquareaAsync<TResponse>(string, IReadOnlyDictionary<string, string>?, CancellationToken)
Posts to a legacy Aquarea cookie endpoint with the upstream bodyless request shape.
public Task<TResponse> PostLegacyAquareaAsync<TResponse>(string relativePath, IReadOnlyDictionary<string, string>? cookies = null, CancellationToken cancellationToken = default) where TResponse : class
Parameters
relativePathstringThe path within the configured Aquarea origin.
cookiesIReadOnlyDictionary<string, string>Additional cookies; an accessToken override is not accepted.
cancellationTokenCancellationTokenCancels waiting, refresh or submission.
Returns
- Task<TResponse>
The modeled acknowledged response; uncertain submissions are never retried.
Type Parameters
TResponseThe attribute-defined response model.
RefreshAsync(DeviceObservation<AcSnapshot>, StatusSource, CancellationToken)
Refreshes an application-owned AC observation and reports whether its state changed.
public Task<bool> RefreshAsync(DeviceObservation<AcSnapshot> device, StatusSource source = StatusSource.Live, CancellationToken cancellationToken = default)
Parameters
deviceDeviceObservation<AcSnapshot>The observation associated with the intended device.
sourceStatusSourceLive or explicitly cached data.
cancellationTokenCancellationTokenCancels the read.
Returns
RefreshAsync(DeviceObservation<AquareaSnapshot>, StatusSource, CancellationToken)
Refreshes an application-owned Aquarea observation.
public Task<bool> RefreshAsync(DeviceObservation<AquareaSnapshot> device, StatusSource source = StatusSource.Live, CancellationToken cancellationToken = default)
Parameters
deviceDeviceObservation<AquareaSnapshot>The observation of the intended gateway.
sourceStatusSourceLive or explicitly cached data.
cancellationTokenCancellationTokenCancels the read.
Returns
RefreshAsync(DeviceObservation<HotWaterSnapshot>, CancellationToken)
Refreshes an application-owned HWS observation.
public Task<bool> RefreshAsync(DeviceObservation<HotWaterSnapshot> device, CancellationToken cancellationToken = default)
Parameters
deviceDeviceObservation<HotWaterSnapshot>The observation of the intended tank.
cancellationTokenCancellationTokenCancels the live read; no cached HWS route is modeled upstream.
Returns
RefreshSessionAsync(CancellationToken)
Refreshes credentials without replaying any device command.
public Task<ComfortCloudSession> RefreshSessionAsync(CancellationToken cancellationToken = default)
Parameters
cancellationTokenCancellationTokenCancels waiting or OAuth refresh.
Returns
- Task<ComfortCloudSession>
The latest token snapshot, including any rotated refresh token.
RestoreSessionAsync(ComfortCloudSession, CancellationToken)
Restores application-owned credentials without validating them against the cloud.
public Task RestoreSessionAsync(ComfortCloudSession session, CancellationToken cancellationToken = default)
Parameters
sessionComfortCloudSessionA previously saved session; expiration is checked before the next cloud operation.
cancellationTokenCancellationTokenCancels waiting for the client gate.
Returns
- Task
A task completing when the in-memory credentials are replaced.
SetAcScheduleAsync(AcSchedule, CancellationToken)
Replaces an air-conditioner weekly schedule.
public Task SetAcScheduleAsync(AcSchedule schedule, CancellationToken cancellationToken = default)
Parameters
scheduleAcScheduleThe complete seven-day schedule with explicit device GUID and activation.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task
A task completing on cloud acknowledgement; unknown wire fields remain preserved.
SetAcScheduleEnabledAsync(string, bool, CancellationToken)
Reads, edits only activation, and replaces an AC weekly schedule.
public Task<AcSchedule> SetAcScheduleEnabledAsync(string deviceGuid, bool enabled, CancellationToken cancellationToken = default)
Parameters
deviceGuidstringThe device whose schedule is read and written.
enabledboolThe requested timer activation.
cancellationTokenCancellationTokenCancels reading or writing.
Returns
- Task<AcSchedule>
The submitted schedule after acknowledgement; an absent schedule is an error.
SetAquareaScheduleAsync(string, AquareaSchedule, CancellationToken)
Replaces an Aquarea weekly schedule without changing its explicit activation value.
public Task SetAquareaScheduleAsync(string gatewayId, AquareaSchedule schedule, CancellationToken cancellationToken = default)
Parameters
gatewayIdstringThe Aquarea gateway GUID.
scheduleAquareaScheduleA complete seven-day schedule; obtain it from the same device before editing.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task
A task completing on cloud acknowledgement; no retry is performed.
SetAquareaScheduleEnabledAsync(string, bool, CancellationToken)
Reads, edits only activation, and replaces an Aquarea weekly schedule.
public Task<AquareaSchedule> SetAquareaScheduleEnabledAsync(string gatewayId, bool enabled, CancellationToken cancellationToken = default)
Parameters
gatewayIdstringThe gateway whose schedule is read and written.
enabledboolThe requested timer activation.
cancellationTokenCancellationTokenCancels reading or writing; uncertain writes are not retried.
Returns
- Task<AquareaSchedule>
The submitted schedule after cloud acknowledgement, without claiming a device readback.
UpdateAcAsync(string, AcUpdate, CancellationToken)
Applies only explicitly supplied AC settings without implicitly powering the device on.
public Task UpdateAcAsync(string deviceGuid, AcUpdate update, CancellationToken cancellationToken = default)
Parameters
deviceGuidstringThe discovered device GUID.
updateAcUpdateThe intended settings. Automatic swing requests preserve the other axis from a fresh read.
cancellationTokenCancellationTokenCancels waiting, any required read or the control request.
Returns
- Task
A task completing on acknowledgement; physical state must be read separately.
UpdateAppVersionAsync(AppVersionDiscovery, CancellationToken)
Explicitly discovers and selects a current app version without replaying any cloud command.
public Task<AppVersionObservation> UpdateAppVersionAsync(AppVersionDiscovery discovery, CancellationToken cancellationToken = default)
Parameters
discoveryAppVersionDiscoveryThe application-owned version-discovery helper.
cancellationTokenCancellationTokenCancels discovery or waiting for active client requests.
Returns
- Task<AppVersionObservation>
The selected observation, which the application may persist.
UpdateAquareaAsync(string, AquareaUpdate, CancellationToken)
Applies explicit Aquarea changes while preserving other zones and tank operation.
public Task UpdateAquareaAsync(string gatewayId, AquareaUpdate update, CancellationToken cancellationToken = default)
Parameters
gatewayIdstringThe discovered Aquarea device GUID.
updateAquareaUpdateOnly the intended changes. Branch and Eco/Comfort changes first obtain a fresh status snapshot.
cancellationTokenCancellationTokenCancels waiting, the preliminary read or the control request.
Returns
- Task
A task completing on cloud acknowledgement, which does not itself confirm physical device state.
Remarks
No device command is retried automatically. Concurrent changes made outside this client may race a read/modify/write operation.
UpdateHotWaterAsync(string, HotWaterUpdate, CancellationToken)
Applies explicit standalone HWS changes through the hphw control endpoint.
public Task UpdateHotWaterAsync(string deviceGuid, HotWaterUpdate update, CancellationToken cancellationToken = default)
Parameters
deviceGuidstringThe discovered HWS device GUID.
updateHotWaterUpdateThe explicit boost, operation mode or complete weekly schedule.
cancellationTokenCancellationTokenCancels waiting or the request.
Returns
- Task
A task completing on cloud acknowledgement; no command is retried.
Events
SessionChanged
Occurs after validated session credentials change and after the request gate is released.
public event EventHandler<SessionChangedEventArgs>? SessionChanged
Event Type
Remarks
Subscribers may persist tokens. Notifications are ordered and subscriber exceptions are isolated. A session operation initiated inside a subscriber commits its state without waiting for its own queued notification, so reentrant subscribers do not deadlock.