Class ChildReportModeModule

Namespace

KasaTapoClient

Assembly

KasaTapoClient.dll

Provides typed report-mode information for a child sensor device.

public sealed class ChildReportModeModule

Inheritance

object

ChildReportModeModule

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

ReportInterval

Gets the latest reported sensor report interval in seconds.

public int? ReportInterval { get; }

Property Value

int?

State

Gets the latest typed report-mode state for the child device.

public ChildReportModeState? State { get; }

Property Value

ChildReportModeState

Methods

SetIntervalAsync(int, CancellationToken)

Sets the sensor reporting interval on the child device.

public Task SetIntervalAsync(int reportIntervalSeconds, CancellationToken cancellationToken = default)

Parameters

reportIntervalSeconds int

The reporting interval in seconds. Must be positive.

cancellationToken CancellationToken

The cancellation token for the operation.

Returns

Task

A task that completes when the child device and parent state have been refreshed.

Exceptions

NotSupportedException

Thrown when the child device does not report a configurable report interval.

UpdateAsync(CancellationToken)

Refreshes the parent device state and child module data.

public Task UpdateAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task