SidewalkCoverageTestOption

public struct SidewalkCoverageTestOption

Configurable option for starting coverage test.

  • The default interval (second) between each ping initiated by Amazon Sidewalk device in coverage test.

    Declaration

    Swift

    public static let defaultPingInterval: UInt16
  • The minimum value of pingInterval.

    Declaration

    Swift

    public static let minPingInterval: UInt16
  • The maximum value of pingInterval.

    Declaration

    Swift

    public static let maxPingInterval: UInt16
  • The default duration (second) of coverage test.

    Declaration

    Swift

    public static let defaultTestDuration: UInt16
  • The interval (second) between each ping initiated by Amazon Sidewalk device in coverage test.

    The value should be within [5, 2^14 - 1] Note that although this property is declared as UInt16, it can only use 14 bits.

    Declaration

    Swift

    public let pingInterval: UInt16
  • The duration (second) of the coverage test.

    The value should be within [pingInterval, 2^16 - 1]

    Declaration

    Swift

    public let testDuration: UInt16
  • Indicates if Amazon Sidewalk device should provide ping/pong information during the progress of coverage test.

    If true, Amazon Sidewalk Mobile SDK will use onProgressUpdated to provide ping/pong information from Amazon Sidewalk device during the coverage test. This may cause both mobile and Amazon Sidewalk device to consume more power.

    If false, after test is started, there will not be any progress update until ping-pong test is finished (either by testDuration or cancellation) , and at that time Amazon Sidewalk Mobile SDK will collect test report.

    Declaration

    Swift

    public let shouldReceivePingPongProgress: Bool
  • Create a custom option for starting coverage test.