diff --git a/build.gradle.kts b/build.gradle.kts index a16daa9f..7ec44b61 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -19,6 +19,7 @@ dependencies { dokka(project(":homekit")) dokka(project(":internals")) dokka(project(":lights")) + dokka(project(":lightlevel")) dokka(project(":resources")) dokka(project(":rooms")) dokka(project(":scenes")) diff --git a/button/api/button.api b/button/api/button.api index b1adc3bd..1056e1c9 100644 --- a/button/api/button.api +++ b/button/api/button.api @@ -49,10 +49,10 @@ public final class inkapplications/shade/button/structures/Button { public final fun copy-qm0Ps9A (Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;Linkapplications/shade/button/structures/ButtonMetadata;Linkapplications/shade/button/structures/ButtonState;Ljava/lang/String;)Linkapplications/shade/button/structures/Button; public static synthetic fun copy-qm0Ps9A$default (Linkapplications/shade/button/structures/Button;Ljava/lang/String;Linkapplications/shade/structures/ResourceReference;Linkapplications/shade/button/structures/ButtonMetadata;Linkapplications/shade/button/structures/ButtonState;Ljava/lang/String;ILjava/lang/Object;)Linkapplications/shade/button/structures/Button; public fun equals (Ljava/lang/Object;)Z - public final fun getButton ()Linkapplications/shade/button/structures/ButtonState; public final fun getId-XbiYvy0 ()Ljava/lang/String; public final fun getMetadata ()Linkapplications/shade/button/structures/ButtonMetadata; public final fun getOwner ()Linkapplications/shade/structures/ResourceReference; + public final fun getState ()Linkapplications/shade/button/structures/ButtonState; public final fun getType-1y3a6N0 ()Ljava/lang/String; public fun hashCode ()I public fun toString ()Ljava/lang/String; @@ -167,18 +167,17 @@ public final class inkapplications/shade/button/structures/ButtonReport$Companio public final class inkapplications/shade/button/structures/ButtonState { public static final field Companion Linkapplications/shade/button/structures/ButtonState$Companion; - public fun ()V - public fun (Linkapplications/shade/button/structures/ButtonReport;Ljava/lang/Integer;Ljava/util/List;)V - public synthetic fun (Linkapplications/shade/button/structures/ButtonReport;Ljava/lang/Integer;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public synthetic fun (Linkapplications/shade/button/structures/ButtonReport;Lkotlin/time/Duration;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public synthetic fun (Linkapplications/shade/button/structures/ButtonReport;Lkotlin/time/Duration;Ljava/util/List;Lkotlin/jvm/internal/DefaultConstructorMarker;)V public final fun component1 ()Linkapplications/shade/button/structures/ButtonReport; - public final fun component2 ()Ljava/lang/Integer; + public final fun component2-FghU774 ()Lkotlin/time/Duration; public final fun component3 ()Ljava/util/List; - public final fun copy (Linkapplications/shade/button/structures/ButtonReport;Ljava/lang/Integer;Ljava/util/List;)Linkapplications/shade/button/structures/ButtonState; - public static synthetic fun copy$default (Linkapplications/shade/button/structures/ButtonState;Linkapplications/shade/button/structures/ButtonReport;Ljava/lang/Integer;Ljava/util/List;ILjava/lang/Object;)Linkapplications/shade/button/structures/ButtonState; + public final fun copy-Kx4hsE0 (Linkapplications/shade/button/structures/ButtonReport;Lkotlin/time/Duration;Ljava/util/List;)Linkapplications/shade/button/structures/ButtonState; + public static synthetic fun copy-Kx4hsE0$default (Linkapplications/shade/button/structures/ButtonState;Linkapplications/shade/button/structures/ButtonReport;Lkotlin/time/Duration;Ljava/util/List;ILjava/lang/Object;)Linkapplications/shade/button/structures/ButtonState; public fun equals (Ljava/lang/Object;)Z - public final fun getButtonReport ()Linkapplications/shade/button/structures/ButtonReport; - public final fun getEventValues ()Ljava/util/List; - public final fun getRepeatInterval ()Ljava/lang/Integer; + public final fun getEvents ()Ljava/util/List; + public final fun getRepeatInterval-FghU774 ()Lkotlin/time/Duration; + public final fun getReport ()Linkapplications/shade/button/structures/ButtonReport; public fun hashCode ()I public fun toString ()Ljava/lang/String; } diff --git a/button/src/commonMain/kotlin/inkapplications/shade/button/structures/Button.kt b/button/src/commonMain/kotlin/inkapplications/shade/button/structures/Button.kt index e2d9fc22..4d9e49b3 100644 --- a/button/src/commonMain/kotlin/inkapplications/shade/button/structures/Button.kt +++ b/button/src/commonMain/kotlin/inkapplications/shade/button/structures/Button.kt @@ -3,7 +3,6 @@ package inkapplications.shade.button.structures import inkapplications.shade.structures.ResourceId import inkapplications.shade.structures.ResourceReference import inkapplications.shade.structures.ResourceType -import kotlinx.serialization.SerialName import kotlinx.serialization.Serializable /** @@ -31,7 +30,7 @@ data class Button( /** * Button state and configuration. */ - val button: ButtonState, + val state: ButtonState, /** * Type of the supported resources. diff --git a/button/src/commonMain/kotlin/inkapplications/shade/button/structures/ButtonState.kt b/button/src/commonMain/kotlin/inkapplications/shade/button/structures/ButtonState.kt index f8838737..7a9d05d1 100644 --- a/button/src/commonMain/kotlin/inkapplications/shade/button/structures/ButtonState.kt +++ b/button/src/commonMain/kotlin/inkapplications/shade/button/structures/ButtonState.kt @@ -1,7 +1,9 @@ package inkapplications.shade.button.structures +import inkapplications.shade.serialization.MillisecondDurationSerializer import kotlinx.serialization.SerialName import kotlinx.serialization.Serializable +import kotlin.time.Duration /** * State of the button with last event and configuration. @@ -12,17 +14,18 @@ data class ButtonState( * Report of the last button event with timestamp. */ @SerialName("button_report") - val buttonReport: ButtonReport? = null, + val report: ButtonReport? = null, /** * Duration between repeat events when holding the button in milliseconds. */ @SerialName("repeat_interval") - val repeatInterval: Int? = null, + @Serializable(with = MillisecondDurationSerializer::class) + val repeatInterval: Duration? = null, /** * List of all button events that this device supports. */ @SerialName("event_values") - val eventValues: List? = null, + val events: List = emptyList(), ) diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/Main.kt b/cli/src/main/kotlin/inkapplications/shade/cli/Main.kt index 7926656f..bc2188d5 100644 --- a/cli/src/main/kotlin/inkapplications/shade/cli/Main.kt +++ b/cli/src/main/kotlin/inkapplications/shade/cli/Main.kt @@ -2,6 +2,7 @@ package inkapplications.shade.cli import com.github.ajalt.clikt.core.NoOpCliktCommand import com.github.ajalt.clikt.core.subcommands +import inkapplications.shade.cli.buttons.* import inkapplications.shade.cli.connection.AuthorizeCommand import inkapplications.shade.cli.connection.DiscoverCommand import inkapplications.shade.cli.devices.* @@ -9,6 +10,8 @@ import inkapplications.shade.cli.events.EventsCommand import inkapplications.shade.cli.groupedlights.GetGroupedLightCommand import inkapplications.shade.cli.groupedlights.ListGroupedLightsCommand import inkapplications.shade.cli.groupedlights.UpdateGroupedLightCommand +import inkapplications.shade.cli.homekit.* +import inkapplications.shade.cli.lightlevels.* import inkapplications.shade.cli.lights.GetLightCommand import inkapplications.shade.cli.lights.ListLightsCommand import inkapplications.shade.cli.lights.UpdateLightCommand @@ -31,23 +34,32 @@ class Main: NoOpCliktCommand() { DeleteZoneCommand, DiscoverCommand, EventsCommand, + GetButtonCommand, GetDeviceCommand, GetGroupedLightCommand, + GetHomekitCommand, GetLightCommand, + GetLightLevelCommand, GetRoomCommand, GetSceneCommand, GetZoneCommand, IdentifyDeviceCommand, + ListButtonsCommand, ListDevicesCommand, ListGroupedLightsCommand, + ListHomekitCommand, ListLightsCommand, + ListLightLevelsCommand, ListResourcesCommand, ListRoomsCommand, ListScenesCommand, ListZonesCommand, + UpdateButtonCommand, UpdateDeviceCommand, UpdateGroupedLightCommand, + UpdateHomekitCommand, UpdateLightCommand, + UpdateLightLevelCommand, UpdateRoomCommand, UpdateSceneCommand, UpdateZoneCommand, diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/buttons/ButtonOutput.kt b/cli/src/main/kotlin/inkapplications/shade/cli/buttons/ButtonOutput.kt new file mode 100644 index 00000000..f6f7829a --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/buttons/ButtonOutput.kt @@ -0,0 +1,23 @@ +package inkapplications.shade.cli.buttons + +import com.github.ajalt.clikt.core.CliktCommand +import inkapplications.shade.button.structures.Button + +fun CliktCommand.echoButton(button: Button) { + echo("${button.id.value}:") + echo(" Owner: ${button.owner}") + echo(" Control ID: ${button.metadata.controlId}") + val report = button.state.report + if (report != null) { + echo(" Last Event: ${report.event}") + echo(" Updated: ${report.updated}") + } + val repeatInterval = button.state.repeatInterval + if (repeatInterval != null) { + echo(" Repeat Interval: ${repeatInterval}ms") + } + echo(" Events:") + button.state.events.forEach { event -> + echo(" - $event") + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/buttons/GetButtonCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/buttons/GetButtonCommand.kt new file mode 100644 index 00000000..1d935e8a --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/buttons/GetButtonCommand.kt @@ -0,0 +1,20 @@ +package inkapplications.shade.cli.buttons + +import com.github.ajalt.clikt.parameters.arguments.argument +import inkapplications.shade.cli.AuthorizedShadeCommand +import inkapplications.shade.cli.resourceId + +object GetButtonCommand: AuthorizedShadeCommand( + help = "Get data for a specific button" +) { + private val buttonId by argument().resourceId() + + override suspend fun runCommand(): Int { + val button = shade.buttons.getButton(buttonId) + + logger.debug("Got Button: $button") + echoButton(button) + + return 0 + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/buttons/ListButtonsCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/buttons/ListButtonsCommand.kt new file mode 100644 index 00000000..893d4925 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/buttons/ListButtonsCommand.kt @@ -0,0 +1,16 @@ +package inkapplications.shade.cli.buttons + +import inkapplications.shade.cli.AuthorizedShadeCommand + +object ListButtonsCommand: AuthorizedShadeCommand( + help = "Get all of the buttons configured on the Hue bridge" +) { + override suspend fun runCommand(): Int { + val buttons = shade.buttons.listButtons() + + logger.debug("Got Buttons: $buttons") + buttons.forEach(::echoButton) + + return 0 + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/buttons/UpdateButtonCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/buttons/UpdateButtonCommand.kt new file mode 100644 index 00000000..d707eccc --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/buttons/UpdateButtonCommand.kt @@ -0,0 +1,28 @@ +package inkapplications.shade.cli.buttons + +import com.github.ajalt.clikt.parameters.arguments.argument +import inkapplications.shade.button.parameters.ButtonUpdateParameters +import inkapplications.shade.cli.AuthorizedShadeCommand +import inkapplications.shade.cli.resourceId +import inkapplications.shade.structures.ResourceType + +object UpdateButtonCommand: AuthorizedShadeCommand( + help = "Update an existing button on the Hue bridge" +) { + private val buttonId by argument( + help = "The ID of the button resource to be updated" + ).resourceId() + + override suspend fun runCommand(): Int { + val response = shade.buttons.updateButton( + id = buttonId, + parameters = ButtonUpdateParameters( + type = ResourceType.Button, + ), + ) + + logger.debug("Got response $response") + + return 0 + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/homekit/GetHomekitCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/homekit/GetHomekitCommand.kt new file mode 100644 index 00000000..9df3d8e9 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/homekit/GetHomekitCommand.kt @@ -0,0 +1,20 @@ +package inkapplications.shade.cli.homekit + +import com.github.ajalt.clikt.parameters.arguments.argument +import inkapplications.shade.cli.AuthorizedShadeCommand +import inkapplications.shade.cli.resourceId + +object GetHomekitCommand: AuthorizedShadeCommand( + help = "Get data for a specific homekit resource" +) { + private val homekitId by argument().resourceId() + + override suspend fun runCommand(): Int { + val homekit = shade.homekit.getHomekit(homekitId) + + logger.debug("Got Homekit: $homekit") + echoHomekit(homekit) + + return 0 + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/homekit/HomekitOutput.kt b/cli/src/main/kotlin/inkapplications/shade/cli/homekit/HomekitOutput.kt new file mode 100644 index 00000000..9acf33e1 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/homekit/HomekitOutput.kt @@ -0,0 +1,10 @@ +package inkapplications.shade.cli.homekit + +import com.github.ajalt.clikt.core.CliktCommand +import inkapplications.shade.homekit.structures.Homekit + +fun CliktCommand.echoHomekit(homekit: Homekit) { + echo("${homekit.id.value}:") + echo(" Type: ${homekit.type}") + echo(" Status: ${homekit.status}") +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/homekit/ListHomekitCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/homekit/ListHomekitCommand.kt new file mode 100644 index 00000000..5596ec1a --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/homekit/ListHomekitCommand.kt @@ -0,0 +1,16 @@ +package inkapplications.shade.cli.homekit + +import inkapplications.shade.cli.AuthorizedShadeCommand + +object ListHomekitCommand: AuthorizedShadeCommand( + help = "Get all of the homekit resources configured on the Hue bridge" +) { + override suspend fun runCommand(): Int { + val homekitResources = shade.homekit.listHomekit() + + logger.debug("Got Homekit: $homekitResources") + homekitResources.forEach(::echoHomekit) + + return 0 + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/homekit/UpdateHomekitCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/homekit/UpdateHomekitCommand.kt new file mode 100644 index 00000000..c8ddf4a3 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/homekit/UpdateHomekitCommand.kt @@ -0,0 +1,43 @@ +package inkapplications.shade.cli.homekit + +import com.github.ajalt.clikt.parameters.arguments.argument +import com.github.ajalt.clikt.parameters.options.option +import com.github.ajalt.clikt.parameters.types.enum +import inkapplications.shade.cli.AuthorizedShadeCommand +import inkapplications.shade.cli.resourceId +import inkapplications.shade.homekit.parameters.HomekitUpdateParameters +import inkapplications.shade.homekit.structures.HomekitAction + +object UpdateHomekitCommand: AuthorizedShadeCommand( + help = "Invoke an action on a homekit resource" +) { + private val homekitId by argument( + help = "The ID of the homekit resource to be updated" + ).resourceId() + + private val action by option( + help = "Invoke an action on the homekit resource" + ).enum() + + override suspend fun runCommand(): Int { + val action = when(action) { + Actions.Reset -> HomekitAction.Reset + else -> null + } + + val response = shade.homekit.updateHomekit( + id = homekitId, + parameters = HomekitUpdateParameters( + action = action, + ), + ) + + logger.debug("Got response $response") + + return 0 + } + + private enum class Actions { + Reset + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/GetLightLevelCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/GetLightLevelCommand.kt new file mode 100644 index 00000000..7467a293 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/GetLightLevelCommand.kt @@ -0,0 +1,20 @@ +package inkapplications.shade.cli.lightlevels + +import com.github.ajalt.clikt.parameters.arguments.argument +import inkapplications.shade.cli.AuthorizedShadeCommand +import inkapplications.shade.cli.resourceId + +object GetLightLevelCommand: AuthorizedShadeCommand( + help = "Get data for a specific light level sensor" +) { + private val lightLevelId by argument().resourceId() + + override suspend fun runCommand(): Int { + val lightLevel = shade.lightLevels.getLightLevel(lightLevelId) + + logger.debug("Got Light Level: $lightLevel") + echoLightLevel(lightLevel) + + return 0 + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/LightLevelOutput.kt b/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/LightLevelOutput.kt new file mode 100644 index 00000000..3af4ffc5 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/LightLevelOutput.kt @@ -0,0 +1,16 @@ +package inkapplications.shade.cli.lightlevels + +import com.github.ajalt.clikt.core.CliktCommand +import inkapplications.shade.lightlevel.structures.LightLevel + +fun CliktCommand.echoLightLevel(lightLevel: LightLevel) { + echo("${lightLevel.id.value}:") + echo(" Owner: ${lightLevel.owner}") + echo(" Enabled: ${lightLevel.enabled}") + + val report = lightLevel.light.lightLevelReport + if (report != null) { + echo(" Level: ${report.lightLevel}") + echo(" Changed: ${report.changed}") + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/ListLightLevelsCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/ListLightLevelsCommand.kt new file mode 100644 index 00000000..5da8ff2d --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/ListLightLevelsCommand.kt @@ -0,0 +1,16 @@ +package inkapplications.shade.cli.lightlevels + +import inkapplications.shade.cli.AuthorizedShadeCommand + +object ListLightLevelsCommand: AuthorizedShadeCommand( + help = "Get all of the light level sensors configured on the Hue bridge" +) { + override suspend fun runCommand(): Int { + val lightLevels = shade.lightLevels.listLightLevels() + + logger.debug("Got Light Levels: $lightLevels") + lightLevels.forEach(::echoLightLevel) + + return 0 + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/UpdateLightLevelCommand.kt b/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/UpdateLightLevelCommand.kt new file mode 100644 index 00000000..4ae92d24 --- /dev/null +++ b/cli/src/main/kotlin/inkapplications/shade/cli/lightlevels/UpdateLightLevelCommand.kt @@ -0,0 +1,44 @@ +package inkapplications.shade.cli.lightlevels + +import com.github.ajalt.clikt.parameters.arguments.argument +import com.github.ajalt.clikt.parameters.options.option +import com.github.ajalt.clikt.parameters.types.enum +import inkapplications.shade.cli.AuthorizedShadeCommand +import inkapplications.shade.cli.resourceId +import inkapplications.shade.lightlevel.parameters.LightLevelUpdateParameters + +object UpdateLightLevelCommand: AuthorizedShadeCommand( + help = "Update a light level sensor on the Hue bridge" +) { + private val lightLevelId by argument( + help = "The ID of the light level sensor to be updated" + ).resourceId() + + private val enable by option( + help = "Enable the light level sensor" + ).enum() + + override suspend fun runCommand(): Int { + val enabled = when(enable) { + EnableState.Enable -> true + EnableState.Disable -> false + null -> null + } + + val response = shade.lightLevels.updateLightLevel( + id = lightLevelId, + parameters = LightLevelUpdateParameters( + enabled = enabled, + ), + ) + + logger.debug("Got response $response") + + return 0 + } + + enum class EnableState { + Enable, + Disable + } +} diff --git a/cli/src/main/kotlin/inkapplications/shade/cli/rooms/RoomOutput.kt b/cli/src/main/kotlin/inkapplications/shade/cli/rooms/RoomOutput.kt index 3ba802c4..fa8b6dae 100644 --- a/cli/src/main/kotlin/inkapplications/shade/cli/rooms/RoomOutput.kt +++ b/cli/src/main/kotlin/inkapplications/shade/cli/rooms/RoomOutput.kt @@ -1,7 +1,6 @@ package inkapplications.shade.cli.rooms import com.github.ajalt.clikt.core.CliktCommand -import com.github.ajalt.clikt.output.TermUi import inkapplications.shade.rooms.structures.Room fun CliktCommand.echoRoom(room: Room) { diff --git a/core/api/core.api b/core/api/core.api index 4decccbc..f128c073 100644 --- a/core/api/core.api +++ b/core/api/core.api @@ -8,6 +8,7 @@ public final class inkapplications/shade/core/Shade { public fun (Ljava/lang/String;Linkapplications/shade/structures/AuthToken;Linkapplications/shade/structures/SecurityStrategy;Lkimchi/logger/KimchiLogger;)V public synthetic fun (Ljava/lang/String;Linkapplications/shade/structures/AuthToken;Linkapplications/shade/structures/SecurityStrategy;Lkimchi/logger/KimchiLogger;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public final fun getAuth ()Linkapplications/shade/auth/BridgeAuth; + public final fun getButtons ()Linkapplications/shade/button/ButtonControls; public final fun getConfiguration ()Linkapplications/shade/structures/HueConfigurationContainer; public final fun getDevices ()Linkapplications/shade/devices/DeviceControls; public final fun getGroupedLights ()Linkapplications/shade/groupedlights/GroupedLightControls; diff --git a/core/build.gradle.kts b/core/build.gradle.kts index ee6253b3..8735e248 100644 --- a/core/build.gradle.kts +++ b/core/build.gradle.kts @@ -9,10 +9,12 @@ kotlin { dependencies { implementation(projects.internals) api(projects.auth) + api(projects.button) api(projects.discover) api(projects.devices) api(projects.events) api(projects.groupedLights) + api(projects.homekit) api(projects.lights) api(projects.lightlevel) api(projects.resources) @@ -20,7 +22,6 @@ kotlin { api(projects.scenes) api(projects.structures) api(projects.zones) - api(projects.homekit) api(libs.kimchi.logger) } diff --git a/core/src/commonMain/kotlin/inkapplications/shade/core/Shade.kt b/core/src/commonMain/kotlin/inkapplications/shade/core/Shade.kt index 12bec380..7d764954 100644 --- a/core/src/commonMain/kotlin/inkapplications/shade/core/Shade.kt +++ b/core/src/commonMain/kotlin/inkapplications/shade/core/Shade.kt @@ -1,6 +1,7 @@ package inkapplications.shade.core import inkapplications.shade.auth.AuthModule +import inkapplications.shade.button.ShadeButtonsModule import inkapplications.shade.devices.ShadeDevicesModule import inkapplications.shade.discover.DiscoverModule import inkapplications.shade.events.EventsModule @@ -52,6 +53,7 @@ class Shade( internalsModule = internalsModule, logger = logger, ).bridgeAuth + val buttons = ShadeButtonsModule(internalsModule).buttons val devices = ShadeDevicesModule(internalsModule).devices val lights = ShadeLightsModule(internalsModule, eventsModule).lights val lightLevels = ShadeLightLevelModule(internalsModule).lightLevels diff --git a/docs/reference/latest/auth/navigation.html b/docs/reference/latest/auth/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/auth/navigation.html +++ b/docs/reference/latest/auth/navigation.html @@ -374,11 +374,11 @@ -
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/-button-state.html b/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/-button-state.html index 071a4e5c..be7e87d8 100644 --- a/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/-button-state.html +++ b/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/-button-state.html @@ -90,12 +90,12 @@
-
+
button/inkapplications.shade.button.structures/ButtonState/ButtonState

ButtonState

-
constructor(buttonReport: ButtonReport? = null, repeatInterval: Int? = null, eventValues: List<ButtonEvent>? = null)
+
constructor(report: ButtonReport? = null, repeatInterval: Duration? = null, events: List<ButtonEvent> = emptyList())
diff --git a/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/events.html b/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/events.html new file mode 100644 index 00000000..67ac8015 --- /dev/null +++ b/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/events.html @@ -0,0 +1,118 @@ + + + + + events + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
button/inkapplications.shade.button.structures/ButtonState/events
+
+

events

+
+
@SerialName(value = "event_values")
val events: List<ButtonEvent>

List of all button events that this device supports.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/index.html b/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/index.html index e030b4d4..1990bbb1 100644 --- a/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/index.html +++ b/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/index.html @@ -94,24 +94,24 @@
button/inkapplications.shade.button.structures/ButtonState

ButtonState

-
@Serializable
data class ButtonState(val buttonReport: ButtonReport? = null, val repeatInterval: Int? = null, val eventValues: List<ButtonEvent>? = null)

State of the button with last event and configuration.

+
@Serializable
data class ButtonState(val report: ButtonReport? = null, val repeatInterval: Duration? = null, val events: List<ButtonEvent> = emptyList())

State of the button with last event and configuration.

Constructors

-
+
- +
Link copied to clipboard
-
constructor(buttonReport: ButtonReport? = null, repeatInterval: Int? = null, eventValues: List<ButtonEvent>? = null)
+
constructor(report: ButtonReport? = null, repeatInterval: Duration? = null, events: List<ButtonEvent> = emptyList())
@@ -120,47 +120,47 @@

Constructors

Properties

-
+
- - + +
Link copied to clipboard
-
@SerialName(value = "button_report")
val buttonReport: ButtonReport?

Report of the last button event with timestamp.

+
@SerialName(value = "event_values")
val events: List<ButtonEvent>

List of all button events that this device supports.

- +
- - + +
Link copied to clipboard
-
@SerialName(value = "event_values")
val eventValues: List<ButtonEvent>?

List of all button events that this device supports.

+
@SerialName(value = "repeat_interval")
@Serializable(with = MillisecondDurationSerializer::class)
val repeatInterval: Duration?

Duration between repeat events when holding the button in milliseconds.

- +
- - + +
Link copied to clipboard
-
@SerialName(value = "repeat_interval")
val repeatInterval: Int?

Duration between repeat events when holding the button in milliseconds.

+
@SerialName(value = "button_report")
val report: ButtonReport?

Report of the last button event with timestamp.

diff --git a/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/repeat-interval.html b/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/repeat-interval.html index 58542fd0..151b4d24 100644 --- a/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/repeat-interval.html +++ b/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/repeat-interval.html @@ -95,7 +95,7 @@

repeatInterval

-
@SerialName(value = "repeat_interval")
val repeatInterval: Int?

Duration between repeat events when holding the button in milliseconds.

+
@SerialName(value = "repeat_interval")
@Serializable(with = MillisecondDurationSerializer::class)
val repeatInterval: Duration?

Duration between repeat events when holding the button in milliseconds.

diff --git a/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/report.html b/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/report.html new file mode 100644 index 00000000..a3b9bf66 --- /dev/null +++ b/docs/reference/latest/button/inkapplications.shade.button.structures/-button-state/report.html @@ -0,0 +1,118 @@ + + + + + report + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
button/inkapplications.shade.button.structures/ButtonState/report
+
+

report

+
+
@SerialName(value = "button_report")
val report: ButtonReport?

Report of the last button event with timestamp.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/button/inkapplications.shade.button.structures/-button/-button.html b/docs/reference/latest/button/inkapplications.shade.button.structures/-button/-button.html index 92219d89..c3f4b452 100644 --- a/docs/reference/latest/button/inkapplications.shade.button.structures/-button/-button.html +++ b/docs/reference/latest/button/inkapplications.shade.button.structures/-button/-button.html @@ -95,7 +95,7 @@

Button

-
constructor(id: ResourceId, owner: ResourceReference, metadata: ButtonMetadata, button: ButtonState, type: ResourceType = ResourceType.Button)
+
constructor(id: ResourceId, owner: ResourceReference, metadata: ButtonMetadata, state: ButtonState, type: ResourceType = ResourceType.Button)
diff --git a/docs/reference/latest/button/inkapplications.shade.button.structures/-button/index.html b/docs/reference/latest/button/inkapplications.shade.button.structures/-button/index.html index da92ffb6..f0ea65e7 100644 --- a/docs/reference/latest/button/inkapplications.shade.button.structures/-button/index.html +++ b/docs/reference/latest/button/inkapplications.shade.button.structures/-button/index.html @@ -94,7 +94,7 @@
button/inkapplications.shade.button.structures/Button

Button

-
@Serializable
data class Button(val id: ResourceId, val owner: ResourceReference, val metadata: ButtonMetadata, val button: ButtonState, val type: ResourceType = ResourceType.Button)

State and capabilities of a button resource.

+
@Serializable
data class Button(val id: ResourceId, val owner: ResourceReference, val metadata: ButtonMetadata, val state: ButtonState, val type: ResourceType = ResourceType.Button)

State and capabilities of a button resource.

@@ -111,7 +111,7 @@

Constructors

-
constructor(id: ResourceId, owner: ResourceReference, metadata: ButtonMetadata, button: ButtonState, type: ResourceType = ResourceType.Button)
+
constructor(id: ResourceId, owner: ResourceReference, metadata: ButtonMetadata, state: ButtonState, type: ResourceType = ResourceType.Button)
@@ -120,22 +120,7 @@

Constructors

Properties

-
-
-
-
- - -
Link copied to clipboard
-
-
-
-
val button: ButtonState

Button state and configuration.

-
-
-
-
- +
@@ -180,6 +165,21 @@

Properties

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val state: ButtonState

Button state and configuration.

+
+
+
+
diff --git a/docs/reference/latest/button/inkapplications.shade.button.structures/-button/state.html b/docs/reference/latest/button/inkapplications.shade.button.structures/-button/state.html new file mode 100644 index 00000000..bdfa1b5f --- /dev/null +++ b/docs/reference/latest/button/inkapplications.shade.button.structures/-button/state.html @@ -0,0 +1,118 @@ + + + + + state + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
button/inkapplications.shade.button.structures/Button/state
+
+

state

+
+
val state: ButtonState

Button state and configuration.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/button/inkapplications.shade.button.structures/index.html b/docs/reference/latest/button/inkapplications.shade.button.structures/index.html index 01ecb4b9..ef6b62fc 100644 --- a/docs/reference/latest/button/inkapplications.shade.button.structures/index.html +++ b/docs/reference/latest/button/inkapplications.shade.button.structures/index.html @@ -110,7 +110,7 @@

Types

-
@Serializable
data class Button(val id: ResourceId, val owner: ResourceReference, val metadata: ButtonMetadata, val button: ButtonState, val type: ResourceType = ResourceType.Button)

State and capabilities of a button resource.

+
@Serializable
data class Button(val id: ResourceId, val owner: ResourceReference, val metadata: ButtonMetadata, val state: ButtonState, val type: ResourceType = ResourceType.Button)

State and capabilities of a button resource.

@@ -170,7 +170,7 @@

Types

-
@Serializable
data class ButtonState(val buttonReport: ButtonReport? = null, val repeatInterval: Int? = null, val eventValues: List<ButtonEvent>? = null)

State of the button with last event and configuration.

+
@Serializable
data class ButtonState(val report: ButtonReport? = null, val repeatInterval: Duration? = null, val events: List<ButtonEvent> = emptyList())

State of the button with last event and configuration.

diff --git a/docs/reference/latest/button/navigation.html b/docs/reference/latest/button/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/button/navigation.html +++ b/docs/reference/latest/button/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/core/inkapplications.shade.core/-shade/buttons.html b/docs/reference/latest/core/inkapplications.shade.core/-shade/buttons.html new file mode 100644 index 00000000..4ff507ea --- /dev/null +++ b/docs/reference/latest/core/inkapplications.shade.core/-shade/buttons.html @@ -0,0 +1,118 @@ + + + + + buttons + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
core/inkapplications.shade.core/Shade/buttons
+
+

buttons

+
+
val buttons: ButtonControls
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/core/inkapplications.shade.core/-shade/index.html b/docs/reference/latest/core/inkapplications.shade.core/-shade/index.html index 40f9b383..1b981bce 100644 --- a/docs/reference/latest/core/inkapplications.shade.core/-shade/index.html +++ b/docs/reference/latest/core/inkapplications.shade.core/-shade/index.html @@ -143,6 +143,21 @@

Properties

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val buttons: ButtonControls
+
+
+
+
@@ -220,6 +235,21 @@

Properties

+ +
+
+
+ + +
Link copied to clipboard
+
+ +
+
diff --git a/docs/reference/latest/core/inkapplications.shade.core/-shade/light-levels.html b/docs/reference/latest/core/inkapplications.shade.core/-shade/light-levels.html new file mode 100644 index 00000000..79485c71 --- /dev/null +++ b/docs/reference/latest/core/inkapplications.shade.core/-shade/light-levels.html @@ -0,0 +1,118 @@ + + + + + lightLevels + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
core/inkapplications.shade.core/Shade/lightLevels
+
+

lightLevels

+
+
val lightLevels: LightLevelControls
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/core/navigation.html b/docs/reference/latest/core/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/core/navigation.html +++ b/docs/reference/latest/core/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/devices/navigation.html b/docs/reference/latest/devices/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/devices/navigation.html +++ b/docs/reference/latest/devices/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/discover/navigation.html b/docs/reference/latest/discover/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/discover/navigation.html +++ b/docs/reference/latest/discover/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/events/navigation.html b/docs/reference/latest/events/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/events/navigation.html +++ b/docs/reference/latest/events/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/grouped-lights/navigation.html b/docs/reference/latest/grouped-lights/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/grouped-lights/navigation.html +++ b/docs/reference/latest/grouped-lights/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/homekit/navigation.html b/docs/reference/latest/homekit/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/homekit/navigation.html +++ b/docs/reference/latest/homekit/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/index.html b/docs/reference/latest/index.html index dcd244fb..765150a0 100644 --- a/docs/reference/latest/index.html +++ b/docs/reference/latest/index.html @@ -177,6 +177,17 @@

All modules:

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
diff --git a/docs/reference/latest/internals/index.html b/docs/reference/latest/internals/index.html index ea03917f..304b9354 100644 --- a/docs/reference/latest/internals/index.html +++ b/docs/reference/latest/internals/index.html @@ -43,12 +43,12 @@
    + - - - + +
      @@ -59,16 +59,16 @@
  • @@ -85,18 +85,18 @@ jvm
    • -
  • +
@@ -130,29 +130,29 @@
-
+

internals

Packages

-
-
+
+
- +
Link copied to clipboard
+
apple
common
-
ios
js
-
native
-
windows
+
linux
+
mingw
diff --git a/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/-platform-module.html b/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/-platform-module.html index c9174a67..1922db77 100644 --- a/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/-platform-module.html +++ b/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/-platform-module.html @@ -43,12 +43,12 @@
    + - - - + +
      @@ -59,16 +59,16 @@
  • @@ -85,18 +85,18 @@ jvm
    • -
  • +
@@ -130,14 +130,14 @@
-
+
internals/inkapplications.shade.internals/PlatformModule/PlatformModule

PlatformModule

-
-
expect constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger = EmptyLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: ERROR CLASS: Symbol not found for HueConfigurationContainer, json: ERROR CLASS: Symbol not found for Json, logger: ERROR CLASS: Symbol not found for KimchiLogger)
+
+
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
expect constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger = EmptyLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: ERROR CLASS: Symbol not found for HueConfigurationContainer, json: ERROR CLASS: Symbol not found for Json, logger: ERROR CLASS: Symbol not found for KimchiLogger)
actual constructor(configurationContainer: ERROR CLASS: Symbol not found for HueConfigurationContainer, json: ERROR CLASS: Symbol not found for Json, logger: ERROR CLASS: Symbol not found for KimchiLogger)
diff --git a/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/create-engine.html b/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/create-engine.html index ac048bc7..ba12ae03 100644 --- a/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/create-engine.html +++ b/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/create-engine.html @@ -43,12 +43,12 @@
    + - - - + +
      @@ -59,16 +59,16 @@
  • @@ -85,18 +85,18 @@ jvm
    • -
  • +
@@ -130,14 +130,14 @@
-
+
internals/inkapplications.shade.internals/PlatformModule/createEngine

createEngine

-
-
expect fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>

Create Ktor http engine based on the platform.

actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: ERROR CLASS: Symbol not found for SecurityStrategy): ERROR CLASS: Symbol not found for HttpClientEngineFactory<*>
+
+
actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
expect fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>

Create Ktor http engine based on the platform.

actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: ERROR CLASS: Symbol not found for SecurityStrategy): ERROR CLASS: Symbol not found for HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: ERROR CLASS: Symbol not found for SecurityStrategy): ERROR CLASS: Symbol not found for HttpClientEngineFactory<*>
diff --git a/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/index.html b/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/index.html index 1a92b253..7407bcb6 100644 --- a/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/index.html +++ b/docs/reference/latest/internals/inkapplications.shade.internals/-platform-module/index.html @@ -43,12 +43,12 @@
    + - - - + +
      @@ -59,16 +59,16 @@
  • @@ -85,18 +85,18 @@ jvm
    • -
  • +
@@ -130,32 +130,32 @@
-
+
internals/inkapplications.shade.internals/PlatformModule

PlatformModule

-
-
expect class PlatformModule

Provides platform-specific dependencies for the SDK.

actual class PlatformModule
actual class PlatformModule
actual class PlatformModule
actual class PlatformModule
actual class PlatformModule
+
+
actual class PlatformModule
expect class PlatformModule

Provides platform-specific dependencies for the SDK.

actual class PlatformModule
actual class PlatformModule
actual class PlatformModule
actual class PlatformModule

Constructors

-
-
+
+
- +
Link copied to clipboard
-
-
expect constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger = EmptyLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: ERROR CLASS: Symbol not found for HueConfigurationContainer, json: ERROR CLASS: Symbol not found for Json, logger: ERROR CLASS: Symbol not found for KimchiLogger)
+
+
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
expect constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger = EmptyLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger)
actual constructor(configurationContainer: ERROR CLASS: Symbol not found for HueConfigurationContainer, json: ERROR CLASS: Symbol not found for Json, logger: ERROR CLASS: Symbol not found for KimchiLogger)
actual constructor(configurationContainer: ERROR CLASS: Symbol not found for HueConfigurationContainer, json: ERROR CLASS: Symbol not found for Json, logger: ERROR CLASS: Symbol not found for KimchiLogger)
@@ -202,19 +202,19 @@

Functions

- -
+ +
- +
Link copied to clipboard
-
-
expect fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>

Create Ktor http engine based on the platform.

actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: ERROR CLASS: Symbol not found for SecurityStrategy): ERROR CLASS: Symbol not found for HttpClientEngineFactory<*>
+
+
actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
expect fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>

Create Ktor http engine based on the platform.

actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: ERROR CLASS: Symbol not found for SecurityStrategy): ERROR CLASS: Symbol not found for HttpClientEngineFactory<*>
actual fun createEngine(securityStrategy: ERROR CLASS: Symbol not found for SecurityStrategy): ERROR CLASS: Symbol not found for HttpClientEngineFactory<*>
diff --git a/docs/reference/latest/internals/inkapplications.shade.internals/index.html b/docs/reference/latest/internals/inkapplications.shade.internals/index.html index e043e5ba..450d8070 100644 --- a/docs/reference/latest/internals/inkapplications.shade.internals/index.html +++ b/docs/reference/latest/internals/inkapplications.shade.internals/index.html @@ -43,12 +43,12 @@
    + - - - + +
      @@ -59,16 +59,16 @@
  • @@ -85,18 +85,18 @@ jvm
    • -
  • +
@@ -130,7 +130,7 @@
-
+
internals/inkapplications.shade.internals

Package-level declarations

@@ -215,19 +215,19 @@

Types

- -
+ +
- +
Link copied to clipboard
-
-
expect class PlatformModule

Provides platform-specific dependencies for the SDK.

actual class PlatformModule
actual class PlatformModule
actual class PlatformModule
actual class PlatformModule
actual class PlatformModule
+
+
actual class PlatformModule
expect class PlatformModule

Provides platform-specific dependencies for the SDK.

actual class PlatformModule
actual class PlatformModule
actual class PlatformModule
actual class PlatformModule
diff --git a/docs/reference/latest/internals/navigation.html b/docs/reference/latest/internals/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/internals/navigation.html +++ b/docs/reference/latest/internals/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/lightlevel/index.html b/docs/reference/latest/lightlevel/index.html new file mode 100644 index 00000000..5a0fdfbb --- /dev/null +++ b/docs/reference/latest/lightlevel/index.html @@ -0,0 +1,173 @@ + + + + + lightlevel + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
+
+

lightlevel

+
+

Packages

+
+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
common
+
+
+
+
+
+
+ +
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
common
+
+
+
+
+
+
+ +
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
common
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/-light-level-update-parameters.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/-light-level-update-parameters.html new file mode 100644 index 00000000..6555a037 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/-light-level-update-parameters.html @@ -0,0 +1,118 @@ + + + + + LightLevelUpdateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.parameters/LightLevelUpdateParameters/LightLevelUpdateParameters
+
+

LightLevelUpdateParameters

+
+
constructor(enabled: Boolean? = null)
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/enabled.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/enabled.html new file mode 100644 index 00000000..13ea6abd --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/enabled.html @@ -0,0 +1,118 @@ + + + + + enabled + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.parameters/LightLevelUpdateParameters/enabled
+
+

enabled

+
+
val enabled: Boolean?

Whether the sensor is activated.

true when sensor is activated, false when deactivated.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/index.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/index.html new file mode 100644 index 00000000..208bee83 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/-light-level-update-parameters/index.html @@ -0,0 +1,161 @@ + + + + + LightLevelUpdateParameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.parameters/LightLevelUpdateParameters
+
+

LightLevelUpdateParameters

+
@Serializable
data class LightLevelUpdateParameters(val enabled: Boolean? = null)

Parameters that can be specified when updating a light level sensor.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(enabled: Boolean? = null)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val enabled: Boolean?

Whether the sensor is activated.

+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/index.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/index.html new file mode 100644 index 00000000..743b6a51 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.parameters/index.html @@ -0,0 +1,141 @@ + + + + + inkapplications.shade.lightlevel.parameters + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.parameters
+
+

Package-level declarations

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class LightLevelUpdateParameters(val enabled: Boolean? = null)

Parameters that can be specified when updating a light level sensor.

+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/-light-level-report.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/-light-level-report.html new file mode 100644 index 00000000..6247a1b4 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/-light-level-report.html @@ -0,0 +1,118 @@ + + + + + LightLevelReport + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevelReport/LightLevelReport
+
+

LightLevelReport

+
+
constructor(changed: Instant, lightLevel: Illuminance)
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/changed.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/changed.html new file mode 100644 index 00000000..dedce085 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/changed.html @@ -0,0 +1,118 @@ + + + + + changed + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevelReport/changed
+
+

changed

+
+
val changed: Instant

Last time the value of this property was changed.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/index.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/index.html new file mode 100644 index 00000000..69cfa6ec --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/index.html @@ -0,0 +1,176 @@ + + + + + LightLevelReport + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevelReport
+
+

LightLevelReport

+
@Serializable
data class LightLevelReport(val changed: Instant, val lightLevel: Illuminance)

Report containing light level sensor data.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(changed: Instant, lightLevel: Illuminance)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val changed: Instant

Last time the value of this property was changed.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "light_level")
@Serializable(with = ScaledLuxSerializer::class)
val lightLevel: Illuminance

Light level measured by sensor.

+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/light-level.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/light-level.html new file mode 100644 index 00000000..58081de8 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-report/light-level.html @@ -0,0 +1,118 @@ + + + + + lightLevel + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevelReport/lightLevel
+
+

lightLevel

+
+
@SerialName(value = "light_level")
@Serializable(with = ScaledLuxSerializer::class)
val lightLevel: Illuminance

Light level measured by sensor.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/-light-level-value.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/-light-level-value.html new file mode 100644 index 00000000..f8582977 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/-light-level-value.html @@ -0,0 +1,118 @@ + + + + + LightLevelValue + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevelValue/LightLevelValue
+
+

LightLevelValue

+
+
constructor(lightLevelReport: LightLevelReport? = null)
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/index.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/index.html new file mode 100644 index 00000000..4cac9f3d --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/index.html @@ -0,0 +1,161 @@ + + + + + LightLevelValue + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevelValue
+
+

LightLevelValue

+
@Serializable
data class LightLevelValue(val lightLevelReport: LightLevelReport? = null)

Light level sensor data.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(lightLevelReport: LightLevelReport? = null)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@SerialName(value = "light_level_report")
val lightLevelReport: LightLevelReport?

Detailed light level report with timestamp.

+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/light-level-report.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/light-level-report.html new file mode 100644 index 00000000..9f0791ae --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level-value/light-level-report.html @@ -0,0 +1,118 @@ + + + + + lightLevelReport + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevelValue/lightLevelReport
+
+

lightLevelReport

+
+
@SerialName(value = "light_level_report")
val lightLevelReport: LightLevelReport?

Detailed light level report with timestamp.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/-light-level.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/-light-level.html new file mode 100644 index 00000000..acae1be7 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/-light-level.html @@ -0,0 +1,118 @@ + + + + + LightLevel + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevel/LightLevel
+
+

LightLevel

+
+
constructor(id: ResourceId, owner: ResourceReference, enabled: Boolean, light: LightLevelValue, type: ResourceType = ResourceType.LightLevel)
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/enabled.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/enabled.html new file mode 100644 index 00000000..56f93b6d --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/enabled.html @@ -0,0 +1,118 @@ + + + + + enabled + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevel/enabled
+
+

enabled

+
+
val enabled: Boolean

Whether the sensor is activated.

true when sensor is activated, false when deactivated.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/id.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/id.html new file mode 100644 index 00000000..1fb5d3d9 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/id.html @@ -0,0 +1,118 @@ + + + + + id + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevel/id
+
+

id

+
+
val id: ResourceId

Unique identifier representing a specific light level sensor instance.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/index.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/index.html new file mode 100644 index 00000000..f32e782b --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/index.html @@ -0,0 +1,221 @@ + + + + + LightLevel + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevel
+
+

LightLevel

+
@Serializable
data class LightLevel(val id: ResourceId, val owner: ResourceReference, val enabled: Boolean, val light: LightLevelValue, val type: ResourceType = ResourceType.LightLevel)

State and capabilities of a light level sensor resource.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(id: ResourceId, owner: ResourceReference, enabled: Boolean, light: LightLevelValue, type: ResourceType = ResourceType.LightLevel)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val enabled: Boolean

Whether the sensor is activated.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val id: ResourceId

Unique identifier representing a specific light level sensor instance.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val light: LightLevelValue

Light level sensor data.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val owner: ResourceReference

Owner of the service.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val type: ResourceType

Type of the supported resource.

+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/light.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/light.html new file mode 100644 index 00000000..7e30eaf0 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/light.html @@ -0,0 +1,118 @@ + + + + + light + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevel/light
+
+

light

+
+
val light: LightLevelValue

Light level sensor data.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/owner.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/owner.html new file mode 100644 index 00000000..349c1cec --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/owner.html @@ -0,0 +1,118 @@ + + + + + owner + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevel/owner
+
+

owner

+
+
val owner: ResourceReference

Owner of the service.

In case the owner service is deleted, the service also gets deleted.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/type.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/type.html new file mode 100644 index 00000000..95c8bbde --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/-light-level/type.html @@ -0,0 +1,118 @@ + + + + + type + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures/LightLevel/type
+
+

type

+
+
val type: ResourceType

Type of the supported resource.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/index.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/index.html new file mode 100644 index 00000000..804af36e --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel.structures/index.html @@ -0,0 +1,171 @@ + + + + + inkapplications.shade.lightlevel.structures + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel.structures
+
+

Package-level declarations

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class LightLevel(val id: ResourceId, val owner: ResourceReference, val enabled: Boolean, val light: LightLevelValue, val type: ResourceType = ResourceType.LightLevel)

State and capabilities of a light level sensor resource.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class LightLevelReport(val changed: Instant, val lightLevel: Illuminance)

Report containing light level sensor data.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@Serializable
data class LightLevelValue(val lightLevelReport: LightLevelReport? = null)

Light level sensor data.

+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/get-light-level.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/get-light-level.html new file mode 100644 index 00000000..8311c096 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/get-light-level.html @@ -0,0 +1,118 @@ + + + + + getLightLevel + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel/LightLevelControls/getLightLevel
+
+

getLightLevel

+
+
abstract suspend fun getLightLevel(id: ResourceId): LightLevel

Get the state of a single light level sensor.

Return

State and capability information about the light level sensor.

Parameters

id

The resource ID of the light level sensor to fetch data about.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/index.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/index.html new file mode 100644 index 00000000..7c0e35cc --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/index.html @@ -0,0 +1,172 @@ + + + + + LightLevelControls + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel/LightLevelControls
+
+

LightLevelControls

+
interface LightLevelControls

Actions to get light level sensor data from the hue system.

+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract suspend fun getLightLevel(id: ResourceId): LightLevel

Get the state of a single light level sensor.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract suspend fun listLightLevels(): List<LightLevel>

Get a list of light level sensors configured on the hue service.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract suspend fun updateLightLevel(id: ResourceId, parameters: LightLevelUpdateParameters): ResourceReference

Update a light level sensor on the hue bridge.

+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/list-light-levels.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/list-light-levels.html new file mode 100644 index 00000000..259d70fe --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/list-light-levels.html @@ -0,0 +1,118 @@ + + + + + listLightLevels + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel/LightLevelControls/listLightLevels
+
+

listLightLevels

+
+
abstract suspend fun listLightLevels(): List<LightLevel>

Get a list of light level sensors configured on the hue service.

Return

A list of all light level sensors configured on the bridge.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/update-light-level.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/update-light-level.html new file mode 100644 index 00000000..4fd4e308 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-light-level-controls/update-light-level.html @@ -0,0 +1,118 @@ + + + + + updateLightLevel + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel/LightLevelControls/updateLightLevel
+
+

updateLightLevel

+
+
abstract suspend fun updateLightLevel(id: ResourceId, parameters: LightLevelUpdateParameters): ResourceReference

Update a light level sensor on the hue bridge.

Return

A reference to the updated resource.

Parameters

id

The resource ID of the light level sensor to be updated.

parameters

Data about the light level sensor to be updated.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/-shade-light-level-module.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/-shade-light-level-module.html new file mode 100644 index 00000000..1c521cf5 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/-shade-light-level-module.html @@ -0,0 +1,118 @@ + + + + + ShadeLightLevelModule + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel/ShadeLightLevelModule/ShadeLightLevelModule
+
+

ShadeLightLevelModule

+
+
constructor(internalsModule: InternalsModule)
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/index.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/index.html new file mode 100644 index 00000000..02daab91 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/index.html @@ -0,0 +1,161 @@ + + + + + ShadeLightLevelModule + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel/ShadeLightLevelModule
+
+

ShadeLightLevelModule

+
class ShadeLightLevelModule(internalsModule: InternalsModule)

Provides access to light level sensor services.

These are offered by devices with light level sensing capabilities.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(internalsModule: InternalsModule)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+ +
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/light-levels.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/light-levels.html new file mode 100644 index 00000000..32a39d35 --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/-shade-light-level-module/light-levels.html @@ -0,0 +1,118 @@ + + + + + lightLevels + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel/ShadeLightLevelModule/lightLevels
+
+

lightLevels

+
+
val lightLevels: LightLevelControls
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/index.html b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/index.html new file mode 100644 index 00000000..70ba444e --- /dev/null +++ b/docs/reference/latest/lightlevel/inkapplications.shade.lightlevel/index.html @@ -0,0 +1,156 @@ + + + + + inkapplications.shade.lightlevel + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
lightlevel/inkapplications.shade.lightlevel
+
+

Package-level declarations

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
interface LightLevelControls

Actions to get light level sensor data from the hue system.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
class ShadeLightLevelModule(internalsModule: InternalsModule)

Provides access to light level sensor services.

+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/lightlevel/navigation.html b/docs/reference/latest/lightlevel/navigation.html new file mode 100644 index 00000000..d71c5de6 --- /dev/null +++ b/docs/reference/latest/lightlevel/navigation.html @@ -0,0 +1,1417 @@ +
+
+
+ authSkip to content +
+
+
+ inkapplications.shade.authSkip to content +
+
+
+ AuthModule +
+
+
+
+ BridgeAuth +
+
+
+
+
+ inkapplications.shade.auth.structuresSkip to content +
+
+
+ AppId +
+
+
+
+
+
+ buttonSkip to content +
+
+
+ inkapplications.shade.buttonSkip to content +
+
+
+ ButtonControls +
+
+
+
+ ShadeButtonsModule +
+
+
+
+
+ inkapplications.shade.button.parametersSkip to content +
+
+
+ ButtonUpdateParameters +
+
+
+
+
+ inkapplications.shade.button.structuresSkip to content +
+
+
+ Button +
+
+
+
+ ButtonEventSkip to content +
+
+
+ Companion +
+
+
+
+
+ ButtonMetadata +
+
+
+
+ ButtonReport +
+
+
+
+ ButtonState +
+
+
+
+
+
+ coreSkip to content +
+
+
+ inkapplications.shade.coreSkip to content +
+
+
+ events +
+
+
+
+ Shade +
+
+
+
+
+
+ devicesSkip to content +
+
+
+ inkapplications.shade.devicesSkip to content +
+
+
+ DeviceControls +
+
+
+
+ ShadeDevicesModule +
+
+
+
+
+ inkapplications.shade.devices.parametersSkip to content +
+
+
+ DeviceMetadataParameters +
+
+
+
+ UpdateDeviceParameters +
+
+
+
+
+ inkapplications.shade.devices.structuresSkip to content +
+
+
+ Device +
+
+
+
+ HardwarePlatformType +
+
+
+
+ ModelId +
+
+
+
+ ProductArchetypeSkip to content +
+
+
+ Companion +
+
+
+
+
+ ProductData +
+
+
+
+ ProductMetadata +
+
+
+
+
+
+ discoverSkip to content +
+
+
+ inkapplications.shade.discoverSkip to content +
+
+
+ BridgeDiscovery +
+
+
+
+ DiscoverModule +
+
+
+
+
+ inkapplications.shade.discover.structuresSkip to content +
+
+
+ Bridge +
+
+
+
+ BridgeId +
+
+
+
+
+
+ eventsSkip to content +
+
+
+ inkapplications.shade.eventsSkip to content +
+
+
+ Events +
+
+
+
+ EventSerializerContainer +
+
+
+
+ EventsModule +
+
+
+
+
+ shade.eventsSkip to content +
+
+
+ events +
+
+
+
+
+
+ grouped-lightsSkip to content +
+
+
+ inkapplications.shade.groupedlightsSkip to content +
+
+
+ GroupedLightControls +
+
+
+
+ ShadeGroupedLightsModule +
+
+
+
+
+ inkapplications.shade.groupedlights.eventsSkip to content +
+
+
+ GroupedLightEvent +
+
+
+
+
+ inkapplications.shade.groupedlights.parametersSkip to content +
+
+
+ GroupedLightUpdateParameters +
+
+
+
+
+ inkapplications.shade.groupedlights.structuresSkip to content +
+
+
+ GroupDimmingInfo +
+
+
+
+ GroupedLight +
+
+
+
+
+
+ homekitSkip to content +
+
+
+ inkapplications.shade.homekitSkip to content +
+
+
+ HomekitControls +
+
+
+
+ ShadeHomekitModule +
+
+
+
+
+ inkapplications.shade.homekit.parametersSkip to content +
+
+
+ HomekitUpdateParameters +
+
+
+
+
+ inkapplications.shade.homekit.structuresSkip to content +
+
+
+ Homekit +
+
+
+
+ HomekitActionSkip to content +
+
+
+ Companion +
+
+
+
+
+ HomekitStatusSkip to content +
+
+
+ Companion +
+
+
+
+
+
+
+ internalsSkip to content +
+
+
+ inkapplications.shade.internalsSkip to content +
+
+
+ CachedProperty +
+
+
+
+ deleteData() +
+
+
+
+ DummyConfigurationContainer +
+
+
+
+ getData() +
+
+
+
+ HueHttpClient +
+
+
+
+ HueStubClient +
+
+
+
+ InternalsModule +
+
+
+
+ PlatformModule +
+
+
+
+ postData() +
+
+
+
+ putData() +
+
+
+
+ SseClient +
+
+
+
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
+
+
+ lightsSkip to content +
+
+
+ inkapplications.shade.lightsSkip to content +
+
+
+ LightControls +
+
+
+
+ ShadeLightsModule +
+
+
+
+
+ inkapplications.shade.lights.eventsSkip to content +
+
+
+ ColorInfoEvent +
+
+
+
+ ColorTemperatureInfoEvent +
+
+
+
+ DimmingInfoEvent +
+
+
+
+ LightEvent +
+
+
+
+
+ inkapplications.shade.lights.parametersSkip to content +
+
+
+ AlertParameters +
+
+
+
+ ColorParameters +
+
+
+
+ ColorTemperatureDeltaParameters +
+
+
+
+ ColorTemperatureParameters +
+
+
+
+ DeltaActionSkip to content +
+
+
+ Companion +
+
+
+
+
+ DimmingDeltaParameters +
+
+
+
+ DimmingParameters +
+
+
+
+ DynamicsParameters +
+
+
+
+ EffectsParameters +
+
+
+
+ GradientParameters +
+
+
+
+ LightUpdateParameters +
+
+
+
+ TimedEffectsParameters +
+
+
+
+
+ inkapplications.shade.lights.structuresSkip to content +
+
+
+ AlertEffectTypeSkip to content +
+
+
+ Companion +
+
+
+
+
+ AlertInfo +
+
+
+
+ ColorInfo +
+
+
+
+ ColorPalette +
+
+
+
+ ColorTemperatureInfo +
+
+
+
+ ColorTemperaturePalette +
+
+
+
+ ColorTemperatureRange +
+
+
+
+ ColorTemperatureValue +
+
+
+
+ ColorValue +
+
+
+
+ DimmingInfo +
+
+
+
+ DimmingValue +
+
+
+
+ DynamicsStatusSkip to content +
+
+
+ Companion +
+
+
+
+
+ Gamut +
+
+
+
+ GamutTypeSkip to content +
+
+
+ Companion +
+
+
+
+
+ Gradient +
+
+
+
+ GradientModeSkip to content +
+
+
+ Companion +
+
+
+
+
+ GradientPoint +
+
+
+
+ GradientValue +
+
+
+
+ Light +
+
+
+
+ LightDynamics +
+
+
+
+ LightEffectSkip to content +
+
+
+ Companion +
+
+
+
+
+ LightingEffectInfo +
+
+
+
+ LightModeSkip to content +
+
+
+ Companion +
+
+
+
+
+ LightPowerupSkip to content +
+
+
+ Custom +
+
+
+
+ LastOnState +
+
+
+
+ Powerfail +
+
+
+
+ Safety +
+
+
+
+
+ LightSignalSkip to content +
+
+
+ Companion +
+
+
+
+
+ LightSignaling +
+
+
+
+ LightSignalStatus +
+
+
+
+ PowerupColorStateSkip to content +
+
+
+ Color +
+
+
+
+ ColorTemperature +
+
+
+
+ Previous +
+
+
+
+
+ PowerupDimmingStateSkip to content +
+
+
+ Previous +
+
+
+
+ StaticBrightness +
+
+
+
+
+ PowerupPowerStateSkip to content +
+
+
+ Previous +
+
+
+
+ StaticPower +
+
+
+
+ Toggle +
+
+
+
+
+ StandardTemperatures +
+
+
+
+ TimedLightEffectSkip to content +
+
+
+ Companion +
+
+
+
+
+ TimedLightingEffectInfo +
+
+
+
+
+
+ resourcesSkip to content +
+
+
+ inkapplications.shade.resourcesSkip to content +
+
+
+ ResourceControls +
+
+
+
+ ShadeResourcesModule +
+
+
+
+
+ inkapplications.shade.resources.structuresSkip to content +
+
+
+ Resource +
+
+
+
+
+
+ roomsSkip to content +
+
+
+ inkapplications.shade.roomsSkip to content +
+
+
+ RoomControls +
+
+
+
+ ShadeRoomsModule +
+
+
+
+
+ inkapplications.shade.rooms.parametersSkip to content +
+
+
+ RoomCreateParameters +
+
+
+
+ RoomUpdateParameters +
+
+
+
+
+ inkapplications.shade.rooms.structuresSkip to content +
+
+
+ Room +
+
+
+
+
+
+ scenesSkip to content +
+
+
+ inkapplications.shade.scenesSkip to content +
+
+
+ SceneControls +
+
+
+
+ ShadeScenesModule +
+
+
+
+
+ inkapplications.shade.scenes.parametersSkip to content +
+
+
+ SceneCreateParameters +
+
+
+
+ SceneUpdateParameters +
+
+
+
+
+ inkapplications.shade.scenes.structuresSkip to content +
+
+
+ Scene +
+
+
+
+ SceneAction +
+
+
+
+ SceneActionReference +
+
+
+
+ SceneMetadata +
+
+
+
+ ScenePalette +
+
+
+
+ SceneRecall +
+
+
+
+ SceneRecallActionSkip to content +
+
+
+ Companion +
+
+
+
+
+ SceneRecallStatusSkip to content +
+
+
+ Companion +
+
+
+
+
+
+
+ serializationSkip to content +
+
+
+ inkapplications.shade.serializationSkip to content +
+
+
+ DelegateSerializer +
+
+
+
+ ExplicitMiredSerializer +
+
+
+
+ FractionalPercentageSerializer +
+
+
+
+ HueError +
+
+
+
+ HueResponseSkip to content +
+
+
+ Error +
+
+
+
+ Success +
+
+
+
+
+ MillisecondDurationSerializer +
+
+
+
+ MiredSerializer +
+
+
+
+ V1HueErrorSkip to content +
+
+
+ ErrorCodes +
+
+
+
+
+ V1HueResponseSkip to content +
+
+
+ Error +
+
+
+
+ Success +
+
+
+
+
+ WholePercentageSerializer +
+
+
+
+
+
+ structuresSkip to content +
+
+
+ inkapplications.shade.structuresSkip to content +
+
+
+ ApiError +
+
+
+
+ ApiStatusError +
+
+
+
+ AuthorizationTimeoutException +
+
+
+
+ AuthToken +
+
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
+
+ HostnameNotSetException +
+
+
+
+ HueConfigurationContainer +
+
+
+
+ Illuminance +
+
+
+
+ InMemoryConfigurationContainer +
+
+
+
+ InternalErrorException +
+
+
+
+ InvalidConfigurationException +
+
+
+
+ Lux +
+
+
+
+ lux +
+
+
+
+ NetworkException +
+
+
+
+ PowerInfo +
+
+
+
+ PowerValue +
+
+
+
+ PropertiesFileConfiguration +
+
+
+
+ ResourceId +
+
+
+
+ ResourceReference +
+
+
+
+ ResourceTypeSkip to content +
+
+
+ Companion +
+
+
+
+
+ ScaledLux +
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
+
+ CustomCa +
+
+
+
+ HueCa +
+
+
+
+ Insecure +
+
+
+
+ PlatformTrust +
+
+
+
+
+ SegmentArchetypeSkip to content +
+
+
+ Companion +
+
+
+
+
+ SegmentMetadata +
+
+
+
+ SegmentMetadataUpdate +
+
+
+
+ SerializationError +
+
+
+
+ ShadeException +
+
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
+
+ UnauthorizedException +
+
+
+
+ UndocumentedApi +
+
+
+
+ UnexpectedStateException +
+
+
+
+ UnknownEvent +
+
+
+
+ UserError +
+
+
+
+ VersionString +
+
+
+
+
+ inkapplications.shade.structures.parametersSkip to content +
+
+
+ PowerParameters +
+
+
+
+
+
+ zonesSkip to content +
+
+
+ inkapplications.shade.zonesSkip to content +
+
+
+ ShadeZonesModule +
+
+
+
+ ZoneControls +
+
+
+
+
+ inkapplications.shade.zones.parametersSkip to content +
+
+
+ ZoneCreateParameters +
+
+
+
+ ZoneUpdateParameters +
+
+
+
+
+ inkapplications.shade.zones.structuresSkip to content +
+
+
+ Zone +
+
+
+
+
diff --git a/docs/reference/latest/lights/navigation.html b/docs/reference/latest/lights/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/lights/navigation.html +++ b/docs/reference/latest/lights/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/navigation.html b/docs/reference/latest/navigation.html index b9191e9f..8d13426c 100644 --- a/docs/reference/latest/navigation.html +++ b/docs/reference/latest/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/package-list b/docs/reference/latest/package-list index 8a977742..5c09f51f 100644 --- a/docs/reference/latest/package-list +++ b/docs/reference/latest/package-list @@ -31,6 +31,10 @@ inkapplications.shade.homekit.parameters inkapplications.shade.homekit.structures module:internals inkapplications.shade.internals +module:lightlevel +inkapplications.shade.lightlevel +inkapplications.shade.lightlevel.parameters +inkapplications.shade.lightlevel.structures module:lights inkapplications.shade.lights inkapplications.shade.lights.events diff --git a/docs/reference/latest/resources/navigation.html b/docs/reference/latest/resources/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/resources/navigation.html +++ b/docs/reference/latest/resources/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/rooms/navigation.html b/docs/reference/latest/rooms/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/rooms/navigation.html +++ b/docs/reference/latest/rooms/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/scenes/navigation.html b/docs/reference/latest/scenes/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/scenes/navigation.html +++ b/docs/reference/latest/scenes/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/scripts/pages.json b/docs/reference/latest/scripts/pages.json index 607dc6ff..3eaeb4d6 100644 --- a/docs/reference/latest/scripts/pages.json +++ b/docs/reference/latest/scripts/pages.json @@ -1 +1 @@ -[{"name":"abstract suspend fun getDevices(): List","description":"inkapplications.shade.discover.BridgeDiscovery.getDevices","location":"discover/inkapplications.shade.discover/-bridge-discovery/get-devices.html","searchKeys":["getDevices","abstract suspend fun getDevices(): List","inkapplications.shade.discover.BridgeDiscovery.getDevices"]},{"name":"class DiscoverModule","description":"inkapplications.shade.discover.DiscoverModule","location":"discover/inkapplications.shade.discover/-discover-module/index.html","searchKeys":["DiscoverModule","class DiscoverModule","inkapplications.shade.discover.DiscoverModule"]},{"name":"constructor()","description":"inkapplications.shade.discover.DiscoverModule.DiscoverModule","location":"discover/inkapplications.shade.discover/-discover-module/-discover-module.html","searchKeys":["DiscoverModule","constructor()","inkapplications.shade.discover.DiscoverModule.DiscoverModule"]},{"name":"constructor(id: BridgeId, localIp: String, port: Int = 80)","description":"inkapplications.shade.discover.structures.Bridge.Bridge","location":"discover/inkapplications.shade.discover.structures/-bridge/-bridge.html","searchKeys":["Bridge","constructor(id: BridgeId, localIp: String, port: Int = 80)","inkapplications.shade.discover.structures.Bridge.Bridge"]},{"name":"constructor(value: String)","description":"inkapplications.shade.discover.structures.BridgeId.BridgeId","location":"discover/inkapplications.shade.discover.structures/-bridge-id/-bridge-id.html","searchKeys":["BridgeId","constructor(value: String)","inkapplications.shade.discover.structures.BridgeId.BridgeId"]},{"name":"data class Bridge(val id: BridgeId, val localIp: String, val port: Int = 80)","description":"inkapplications.shade.discover.structures.Bridge","location":"discover/inkapplications.shade.discover.structures/-bridge/index.html","searchKeys":["Bridge","data class Bridge(val id: BridgeId, val localIp: String, val port: Int = 80)","inkapplications.shade.discover.structures.Bridge"]},{"name":"interface BridgeDiscovery","description":"inkapplications.shade.discover.BridgeDiscovery","location":"discover/inkapplications.shade.discover/-bridge-discovery/index.html","searchKeys":["BridgeDiscovery","interface BridgeDiscovery","inkapplications.shade.discover.BridgeDiscovery"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.discover.structures.BridgeId.toString","location":"discover/inkapplications.shade.discover.structures/-bridge-id/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.discover.structures.BridgeId.toString"]},{"name":"val id: BridgeId","description":"inkapplications.shade.discover.structures.Bridge.id","location":"discover/inkapplications.shade.discover.structures/-bridge/id.html","searchKeys":["id","val id: BridgeId","inkapplications.shade.discover.structures.Bridge.id"]},{"name":"val localIp: String","description":"inkapplications.shade.discover.structures.Bridge.localIp","location":"discover/inkapplications.shade.discover.structures/-bridge/local-ip.html","searchKeys":["localIp","val localIp: String","inkapplications.shade.discover.structures.Bridge.localIp"]},{"name":"val onlineDiscovery: BridgeDiscovery","description":"inkapplications.shade.discover.DiscoverModule.onlineDiscovery","location":"discover/inkapplications.shade.discover/-discover-module/online-discovery.html","searchKeys":["onlineDiscovery","val onlineDiscovery: BridgeDiscovery","inkapplications.shade.discover.DiscoverModule.onlineDiscovery"]},{"name":"val port: Int","description":"inkapplications.shade.discover.structures.Bridge.port","location":"discover/inkapplications.shade.discover.structures/-bridge/port.html","searchKeys":["port","val port: Int","inkapplications.shade.discover.structures.Bridge.port"]},{"name":"val value: String","description":"inkapplications.shade.discover.structures.BridgeId.value","location":"discover/inkapplications.shade.discover.structures/-bridge-id/value.html","searchKeys":["value","val value: String","inkapplications.shade.discover.structures.BridgeId.value"]},{"name":"value class BridgeId(val value: String)","description":"inkapplications.shade.discover.structures.BridgeId","location":"discover/inkapplications.shade.discover.structures/-bridge-id/index.html","searchKeys":["BridgeId","value class BridgeId(val value: String)","inkapplications.shade.discover.structures.BridgeId"]},{"name":"abstract suspend fun createRoom(parameters: RoomCreateParameters): ResourceReference","description":"inkapplications.shade.rooms.RoomControls.createRoom","location":"rooms/inkapplications.shade.rooms/-room-controls/create-room.html","searchKeys":["createRoom","abstract suspend fun createRoom(parameters: RoomCreateParameters): ResourceReference","inkapplications.shade.rooms.RoomControls.createRoom"]},{"name":"abstract suspend fun deleteRoom(id: ResourceId): ResourceReference","description":"inkapplications.shade.rooms.RoomControls.deleteRoom","location":"rooms/inkapplications.shade.rooms/-room-controls/delete-room.html","searchKeys":["deleteRoom","abstract suspend fun deleteRoom(id: ResourceId): ResourceReference","inkapplications.shade.rooms.RoomControls.deleteRoom"]},{"name":"abstract suspend fun getRoom(id: ResourceId): Room","description":"inkapplications.shade.rooms.RoomControls.getRoom","location":"rooms/inkapplications.shade.rooms/-room-controls/get-room.html","searchKeys":["getRoom","abstract suspend fun getRoom(id: ResourceId): Room","inkapplications.shade.rooms.RoomControls.getRoom"]},{"name":"abstract suspend fun listRooms(): List","description":"inkapplications.shade.rooms.RoomControls.listRooms","location":"rooms/inkapplications.shade.rooms/-room-controls/list-rooms.html","searchKeys":["listRooms","abstract suspend fun listRooms(): List","inkapplications.shade.rooms.RoomControls.listRooms"]},{"name":"abstract suspend fun updateRoom(id: ResourceId, parameters: RoomUpdateParameters): ResourceReference","description":"inkapplications.shade.rooms.RoomControls.updateRoom","location":"rooms/inkapplications.shade.rooms/-room-controls/update-room.html","searchKeys":["updateRoom","abstract suspend fun updateRoom(id: ResourceId, parameters: RoomUpdateParameters): ResourceReference","inkapplications.shade.rooms.RoomControls.updateRoom"]},{"name":"class ShadeRoomsModule(internalsModule: InternalsModule)","description":"inkapplications.shade.rooms.ShadeRoomsModule","location":"rooms/inkapplications.shade.rooms/-shade-rooms-module/index.html","searchKeys":["ShadeRoomsModule","class ShadeRoomsModule(internalsModule: InternalsModule)","inkapplications.shade.rooms.ShadeRoomsModule"]},{"name":"constructor(id: ResourceId, services: List, metadata: SegmentMetadata, children: List)","description":"inkapplications.shade.rooms.structures.Room.Room","location":"rooms/inkapplications.shade.rooms.structures/-room/-room.html","searchKeys":["Room","constructor(id: ResourceId, services: List, metadata: SegmentMetadata, children: List)","inkapplications.shade.rooms.structures.Room.Room"]},{"name":"constructor(internalsModule: InternalsModule)","description":"inkapplications.shade.rooms.ShadeRoomsModule.ShadeRoomsModule","location":"rooms/inkapplications.shade.rooms/-shade-rooms-module/-shade-rooms-module.html","searchKeys":["ShadeRoomsModule","constructor(internalsModule: InternalsModule)","inkapplications.shade.rooms.ShadeRoomsModule.ShadeRoomsModule"]},{"name":"constructor(metadata: SegmentMetadata, children: List)","description":"inkapplications.shade.rooms.parameters.RoomCreateParameters.RoomCreateParameters","location":"rooms/inkapplications.shade.rooms.parameters/-room-create-parameters/-room-create-parameters.html","searchKeys":["RoomCreateParameters","constructor(metadata: SegmentMetadata, children: List)","inkapplications.shade.rooms.parameters.RoomCreateParameters.RoomCreateParameters"]},{"name":"constructor(metadata: SegmentMetadataUpdate? = null, children: List? = null)","description":"inkapplications.shade.rooms.parameters.RoomUpdateParameters.RoomUpdateParameters","location":"rooms/inkapplications.shade.rooms.parameters/-room-update-parameters/-room-update-parameters.html","searchKeys":["RoomUpdateParameters","constructor(metadata: SegmentMetadataUpdate? = null, children: List? = null)","inkapplications.shade.rooms.parameters.RoomUpdateParameters.RoomUpdateParameters"]},{"name":"data class Room(val id: ResourceId, val services: List, val metadata: SegmentMetadata, val children: List)","description":"inkapplications.shade.rooms.structures.Room","location":"rooms/inkapplications.shade.rooms.structures/-room/index.html","searchKeys":["Room","data class Room(val id: ResourceId, val services: List, val metadata: SegmentMetadata, val children: List)","inkapplications.shade.rooms.structures.Room"]},{"name":"data class RoomCreateParameters(val metadata: SegmentMetadata, val children: List)","description":"inkapplications.shade.rooms.parameters.RoomCreateParameters","location":"rooms/inkapplications.shade.rooms.parameters/-room-create-parameters/index.html","searchKeys":["RoomCreateParameters","data class RoomCreateParameters(val metadata: SegmentMetadata, val children: List)","inkapplications.shade.rooms.parameters.RoomCreateParameters"]},{"name":"data class RoomUpdateParameters(val metadata: SegmentMetadataUpdate? = null, val children: List? = null)","description":"inkapplications.shade.rooms.parameters.RoomUpdateParameters","location":"rooms/inkapplications.shade.rooms.parameters/-room-update-parameters/index.html","searchKeys":["RoomUpdateParameters","data class RoomUpdateParameters(val metadata: SegmentMetadataUpdate? = null, val children: List? = null)","inkapplications.shade.rooms.parameters.RoomUpdateParameters"]},{"name":"interface RoomControls","description":"inkapplications.shade.rooms.RoomControls","location":"rooms/inkapplications.shade.rooms/-room-controls/index.html","searchKeys":["RoomControls","interface RoomControls","inkapplications.shade.rooms.RoomControls"]},{"name":"val children: List","description":"inkapplications.shade.rooms.parameters.RoomCreateParameters.children","location":"rooms/inkapplications.shade.rooms.parameters/-room-create-parameters/children.html","searchKeys":["children","val children: List","inkapplications.shade.rooms.parameters.RoomCreateParameters.children"]},{"name":"val children: List","description":"inkapplications.shade.rooms.structures.Room.children","location":"rooms/inkapplications.shade.rooms.structures/-room/children.html","searchKeys":["children","val children: List","inkapplications.shade.rooms.structures.Room.children"]},{"name":"val children: List?","description":"inkapplications.shade.rooms.parameters.RoomUpdateParameters.children","location":"rooms/inkapplications.shade.rooms.parameters/-room-update-parameters/children.html","searchKeys":["children","val children: List?","inkapplications.shade.rooms.parameters.RoomUpdateParameters.children"]},{"name":"val id: ResourceId","description":"inkapplications.shade.rooms.structures.Room.id","location":"rooms/inkapplications.shade.rooms.structures/-room/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.rooms.structures.Room.id"]},{"name":"val metadata: SegmentMetadata","description":"inkapplications.shade.rooms.parameters.RoomCreateParameters.metadata","location":"rooms/inkapplications.shade.rooms.parameters/-room-create-parameters/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadata","inkapplications.shade.rooms.parameters.RoomCreateParameters.metadata"]},{"name":"val metadata: SegmentMetadata","description":"inkapplications.shade.rooms.structures.Room.metadata","location":"rooms/inkapplications.shade.rooms.structures/-room/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadata","inkapplications.shade.rooms.structures.Room.metadata"]},{"name":"val metadata: SegmentMetadataUpdate?","description":"inkapplications.shade.rooms.parameters.RoomUpdateParameters.metadata","location":"rooms/inkapplications.shade.rooms.parameters/-room-update-parameters/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadataUpdate?","inkapplications.shade.rooms.parameters.RoomUpdateParameters.metadata"]},{"name":"val rooms: RoomControls","description":"inkapplications.shade.rooms.ShadeRoomsModule.rooms","location":"rooms/inkapplications.shade.rooms/-shade-rooms-module/rooms.html","searchKeys":["rooms","val rooms: RoomControls","inkapplications.shade.rooms.ShadeRoomsModule.rooms"]},{"name":"val services: List","description":"inkapplications.shade.rooms.structures.Room.services","location":"rooms/inkapplications.shade.rooms.structures/-room/services.html","searchKeys":["services","val services: List","inkapplications.shade.rooms.structures.Room.services"]},{"name":"abstract suspend fun awaitToken(appId: AppId, retries: Int = 50, timeout: Duration = 5.seconds): AuthToken","description":"inkapplications.shade.auth.BridgeAuth.awaitToken","location":"auth/inkapplications.shade.auth/-bridge-auth/await-token.html","searchKeys":["awaitToken","abstract suspend fun awaitToken(appId: AppId, retries: Int = 50, timeout: Duration = 5.seconds): AuthToken","inkapplications.shade.auth.BridgeAuth.awaitToken"]},{"name":"class AuthModule(internalsModule: InternalsModule, logger: KimchiLogger)","description":"inkapplications.shade.auth.AuthModule","location":"auth/inkapplications.shade.auth/-auth-module/index.html","searchKeys":["AuthModule","class AuthModule(internalsModule: InternalsModule, logger: KimchiLogger)","inkapplications.shade.auth.AuthModule"]},{"name":"constructor(appName: String, instanceName: String)","description":"inkapplications.shade.auth.structures.AppId.AppId","location":"auth/inkapplications.shade.auth.structures/-app-id/-app-id.html","searchKeys":["AppId","constructor(appName: String, instanceName: String)","inkapplications.shade.auth.structures.AppId.AppId"]},{"name":"constructor(internalsModule: InternalsModule, logger: KimchiLogger)","description":"inkapplications.shade.auth.AuthModule.AuthModule","location":"auth/inkapplications.shade.auth/-auth-module/-auth-module.html","searchKeys":["AuthModule","constructor(internalsModule: InternalsModule, logger: KimchiLogger)","inkapplications.shade.auth.AuthModule.AuthModule"]},{"name":"data class AppId(val appName: String, val instanceName: String)","description":"inkapplications.shade.auth.structures.AppId","location":"auth/inkapplications.shade.auth.structures/-app-id/index.html","searchKeys":["AppId","data class AppId(val appName: String, val instanceName: String)","inkapplications.shade.auth.structures.AppId"]},{"name":"interface BridgeAuth","description":"inkapplications.shade.auth.BridgeAuth","location":"auth/inkapplications.shade.auth/-bridge-auth/index.html","searchKeys":["BridgeAuth","interface BridgeAuth","inkapplications.shade.auth.BridgeAuth"]},{"name":"val appName: String","description":"inkapplications.shade.auth.structures.AppId.appName","location":"auth/inkapplications.shade.auth.structures/-app-id/app-name.html","searchKeys":["appName","val appName: String","inkapplications.shade.auth.structures.AppId.appName"]},{"name":"val bridgeAuth: BridgeAuth","description":"inkapplications.shade.auth.AuthModule.bridgeAuth","location":"auth/inkapplications.shade.auth/-auth-module/bridge-auth.html","searchKeys":["bridgeAuth","val bridgeAuth: BridgeAuth","inkapplications.shade.auth.AuthModule.bridgeAuth"]},{"name":"val instanceName: String","description":"inkapplications.shade.auth.structures.AppId.instanceName","location":"auth/inkapplications.shade.auth.structures/-app-id/instance-name.html","searchKeys":["instanceName","val instanceName: String","inkapplications.shade.auth.structures.AppId.instanceName"]},{"name":"abstract suspend fun deleteDevice(deviceId: ResourceId): ResourceReference","description":"inkapplications.shade.devices.DeviceControls.deleteDevice","location":"devices/inkapplications.shade.devices/-device-controls/delete-device.html","searchKeys":["deleteDevice","abstract suspend fun deleteDevice(deviceId: ResourceId): ResourceReference","inkapplications.shade.devices.DeviceControls.deleteDevice"]},{"name":"abstract suspend fun getDevice(deviceId: ResourceId): Device","description":"inkapplications.shade.devices.DeviceControls.getDevice","location":"devices/inkapplications.shade.devices/-device-controls/get-device.html","searchKeys":["getDevice","abstract suspend fun getDevice(deviceId: ResourceId): Device","inkapplications.shade.devices.DeviceControls.getDevice"]},{"name":"abstract suspend fun identifyDevice(deviceId: ResourceId): ResourceReference","description":"inkapplications.shade.devices.DeviceControls.identifyDevice","location":"devices/inkapplications.shade.devices/-device-controls/identify-device.html","searchKeys":["identifyDevice","abstract suspend fun identifyDevice(deviceId: ResourceId): ResourceReference","inkapplications.shade.devices.DeviceControls.identifyDevice"]},{"name":"abstract suspend fun listDevices(): List","description":"inkapplications.shade.devices.DeviceControls.listDevices","location":"devices/inkapplications.shade.devices/-device-controls/list-devices.html","searchKeys":["listDevices","abstract suspend fun listDevices(): List","inkapplications.shade.devices.DeviceControls.listDevices"]},{"name":"abstract suspend fun updateDevice(deviceId: ResourceId, parameters: UpdateDeviceParameters): ResourceReference","description":"inkapplications.shade.devices.DeviceControls.updateDevice","location":"devices/inkapplications.shade.devices/-device-controls/update-device.html","searchKeys":["updateDevice","abstract suspend fun updateDevice(deviceId: ResourceId, parameters: UpdateDeviceParameters): ResourceReference","inkapplications.shade.devices.DeviceControls.updateDevice"]},{"name":"class ShadeDevicesModule(internalsModule: InternalsModule)","description":"inkapplications.shade.devices.ShadeDevicesModule","location":"devices/inkapplications.shade.devices/-shade-devices-module/index.html","searchKeys":["ShadeDevicesModule","class ShadeDevicesModule(internalsModule: InternalsModule)","inkapplications.shade.devices.ShadeDevicesModule"]},{"name":"constructor(id: ResourceId, v1Id: String? = null, productData: ProductData, metadata: ProductMetadata, services: List)","description":"inkapplications.shade.devices.structures.Device.Device","location":"devices/inkapplications.shade.devices.structures/-device/-device.html","searchKeys":["Device","constructor(id: ResourceId, v1Id: String? = null, productData: ProductData, metadata: ProductMetadata, services: List)","inkapplications.shade.devices.structures.Device.Device"]},{"name":"constructor(internalsModule: InternalsModule)","description":"inkapplications.shade.devices.ShadeDevicesModule.ShadeDevicesModule","location":"devices/inkapplications.shade.devices/-shade-devices-module/-shade-devices-module.html","searchKeys":["ShadeDevicesModule","constructor(internalsModule: InternalsModule)","inkapplications.shade.devices.ShadeDevicesModule.ShadeDevicesModule"]},{"name":"constructor(key: String)","description":"inkapplications.shade.devices.structures.ProductArchetype.ProductArchetype","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-product-archetype.html","searchKeys":["ProductArchetype","constructor(key: String)","inkapplications.shade.devices.structures.ProductArchetype.ProductArchetype"]},{"name":"constructor(metadata: DeviceMetadataParameters? = null)","description":"inkapplications.shade.devices.parameters.UpdateDeviceParameters.UpdateDeviceParameters","location":"devices/inkapplications.shade.devices.parameters/-update-device-parameters/-update-device-parameters.html","searchKeys":["UpdateDeviceParameters","constructor(metadata: DeviceMetadataParameters? = null)","inkapplications.shade.devices.parameters.UpdateDeviceParameters.UpdateDeviceParameters"]},{"name":"constructor(modelId: ModelId, manufacturerName: String, productName: String, productArchetype: ProductArchetype, certified: Boolean, softwareVersion: VersionString, hardwarePlatformType: HardwarePlatformType? = null)","description":"inkapplications.shade.devices.structures.ProductData.ProductData","location":"devices/inkapplications.shade.devices.structures/-product-data/-product-data.html","searchKeys":["ProductData","constructor(modelId: ModelId, manufacturerName: String, productName: String, productArchetype: ProductArchetype, certified: Boolean, softwareVersion: VersionString, hardwarePlatformType: HardwarePlatformType? = null)","inkapplications.shade.devices.structures.ProductData.ProductData"]},{"name":"constructor(name: String, archetype: ProductArchetype)","description":"inkapplications.shade.devices.structures.ProductMetadata.ProductMetadata","location":"devices/inkapplications.shade.devices.structures/-product-metadata/-product-metadata.html","searchKeys":["ProductMetadata","constructor(name: String, archetype: ProductArchetype)","inkapplications.shade.devices.structures.ProductMetadata.ProductMetadata"]},{"name":"constructor(name: String? = null, archetype: ProductArchetype? = null)","description":"inkapplications.shade.devices.parameters.DeviceMetadataParameters.DeviceMetadataParameters","location":"devices/inkapplications.shade.devices.parameters/-device-metadata-parameters/-device-metadata-parameters.html","searchKeys":["DeviceMetadataParameters","constructor(name: String? = null, archetype: ProductArchetype? = null)","inkapplications.shade.devices.parameters.DeviceMetadataParameters.DeviceMetadataParameters"]},{"name":"constructor(value: String)","description":"inkapplications.shade.devices.structures.HardwarePlatformType.HardwarePlatformType","location":"devices/inkapplications.shade.devices.structures/-hardware-platform-type/-hardware-platform-type.html","searchKeys":["HardwarePlatformType","constructor(value: String)","inkapplications.shade.devices.structures.HardwarePlatformType.HardwarePlatformType"]},{"name":"constructor(value: String)","description":"inkapplications.shade.devices.structures.ModelId.ModelId","location":"devices/inkapplications.shade.devices.structures/-model-id/-model-id.html","searchKeys":["ModelId","constructor(value: String)","inkapplications.shade.devices.structures.ModelId.ModelId"]},{"name":"data class Device(val id: ResourceId, val v1Id: String? = null, val productData: ProductData, val metadata: ProductMetadata, val services: List)","description":"inkapplications.shade.devices.structures.Device","location":"devices/inkapplications.shade.devices.structures/-device/index.html","searchKeys":["Device","data class Device(val id: ResourceId, val v1Id: String? = null, val productData: ProductData, val metadata: ProductMetadata, val services: List)","inkapplications.shade.devices.structures.Device"]},{"name":"data class DeviceMetadataParameters(val name: String? = null, val archetype: ProductArchetype? = null)","description":"inkapplications.shade.devices.parameters.DeviceMetadataParameters","location":"devices/inkapplications.shade.devices.parameters/-device-metadata-parameters/index.html","searchKeys":["DeviceMetadataParameters","data class DeviceMetadataParameters(val name: String? = null, val archetype: ProductArchetype? = null)","inkapplications.shade.devices.parameters.DeviceMetadataParameters"]},{"name":"data class ProductData(val modelId: ModelId, val manufacturerName: String, val productName: String, val productArchetype: ProductArchetype, val certified: Boolean, val softwareVersion: VersionString, val hardwarePlatformType: HardwarePlatformType? = null)","description":"inkapplications.shade.devices.structures.ProductData","location":"devices/inkapplications.shade.devices.structures/-product-data/index.html","searchKeys":["ProductData","data class ProductData(val modelId: ModelId, val manufacturerName: String, val productName: String, val productArchetype: ProductArchetype, val certified: Boolean, val softwareVersion: VersionString, val hardwarePlatformType: HardwarePlatformType? = null)","inkapplications.shade.devices.structures.ProductData"]},{"name":"data class ProductMetadata(val name: String, val archetype: ProductArchetype)","description":"inkapplications.shade.devices.structures.ProductMetadata","location":"devices/inkapplications.shade.devices.structures/-product-metadata/index.html","searchKeys":["ProductMetadata","data class ProductMetadata(val name: String, val archetype: ProductArchetype)","inkapplications.shade.devices.structures.ProductMetadata"]},{"name":"data class UpdateDeviceParameters","description":"inkapplications.shade.devices.parameters.UpdateDeviceParameters","location":"devices/inkapplications.shade.devices.parameters/-update-device-parameters/index.html","searchKeys":["UpdateDeviceParameters","data class UpdateDeviceParameters","inkapplications.shade.devices.parameters.UpdateDeviceParameters"]},{"name":"interface DeviceControls","description":"inkapplications.shade.devices.DeviceControls","location":"devices/inkapplications.shade.devices/-device-controls/index.html","searchKeys":["DeviceControls","interface DeviceControls","inkapplications.shade.devices.DeviceControls"]},{"name":"object Companion","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/index.html","searchKeys":["Companion","object Companion","inkapplications.shade.devices.structures.ProductArchetype.Companion"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.devices.structures.HardwarePlatformType.toString","location":"devices/inkapplications.shade.devices.structures/-hardware-platform-type/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.devices.structures.HardwarePlatformType.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.devices.structures.ModelId.toString","location":"devices/inkapplications.shade.devices.structures/-model-id/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.devices.structures.ModelId.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.devices.structures.ProductArchetype.toString","location":"devices/inkapplications.shade.devices.structures/-product-archetype/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.devices.structures.ProductArchetype.toString"]},{"name":"val Bollard: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.Bollard","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-bollard.html","searchKeys":["Bollard","val Bollard: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.Bollard"]},{"name":"val BridgeV2: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.BridgeV2","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-bridge-v2.html","searchKeys":["BridgeV2","val BridgeV2: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.BridgeV2"]},{"name":"val CandleBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.CandleBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-candle-bulb.html","searchKeys":["CandleBulb","val CandleBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.CandleBulb"]},{"name":"val CeilingHorizontal: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingHorizontal","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ceiling-horizontal.html","searchKeys":["CeilingHorizontal","val CeilingHorizontal: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingHorizontal"]},{"name":"val CeilingRound: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingRound","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ceiling-round.html","searchKeys":["CeilingRound","val CeilingRound: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingRound"]},{"name":"val CeilingSquare: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingSquare","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ceiling-square.html","searchKeys":["CeilingSquare","val CeilingSquare: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingSquare"]},{"name":"val CeilingTube: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingTube","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ceiling-tube.html","searchKeys":["CeilingTube","val CeilingTube: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.CeilingTube"]},{"name":"val ChristmasTree: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.ChristmasTree","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-christmas-tree.html","searchKeys":["ChristmasTree","val ChristmasTree: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.ChristmasTree"]},{"name":"val ClassicBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.ClassicBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-classic-bulb.html","searchKeys":["ClassicBulb","val ClassicBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.ClassicBulb"]},{"name":"val DoubleSpot: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.DoubleSpot","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-double-spot.html","searchKeys":["DoubleSpot","val DoubleSpot: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.DoubleSpot"]},{"name":"val EdisonBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.EdisonBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-edison-bulb.html","searchKeys":["EdisonBulb","val EdisonBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.EdisonBulb"]},{"name":"val EllipseBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.EllipseBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ellipse-bulb.html","searchKeys":["EllipseBulb","val EllipseBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.EllipseBulb"]},{"name":"val FlexibleLamp: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.FlexibleLamp","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-flexible-lamp.html","searchKeys":["FlexibleLamp","val FlexibleLamp: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.FlexibleLamp"]},{"name":"val FloodBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.FloodBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-flood-bulb.html","searchKeys":["FloodBulb","val FloodBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.FloodBulb"]},{"name":"val FloorLantern: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.FloorLantern","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-floor-lantern.html","searchKeys":["FloorLantern","val FloorLantern: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.FloorLantern"]},{"name":"val FloorShade: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.FloorShade","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-floor-shade.html","searchKeys":["FloorShade","val FloorShade: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.FloorShade"]},{"name":"val GroundSpot: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.GroundSpot","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-ground-spot.html","searchKeys":["GroundSpot","val GroundSpot: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.GroundSpot"]},{"name":"val HueBloom: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueBloom","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-bloom.html","searchKeys":["HueBloom","val HueBloom: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueBloom"]},{"name":"val HueCentris: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueCentris","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-centris.html","searchKeys":["HueCentris","val HueCentris: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueCentris"]},{"name":"val HueGo: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueGo","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-go.html","searchKeys":["HueGo","val HueGo: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueGo"]},{"name":"val HueIris: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueIris","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-iris.html","searchKeys":["HueIris","val HueIris: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueIris"]},{"name":"val HueLightstrip: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstrip","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-lightstrip.html","searchKeys":["HueLightstrip","val HueLightstrip: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstrip"]},{"name":"val HueLightstripPc: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstripPc","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-lightstrip-pc.html","searchKeys":["HueLightstripPc","val HueLightstripPc: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstripPc"]},{"name":"val HueLightstripTv: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstripTv","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-lightstrip-tv.html","searchKeys":["HueLightstripTv","val HueLightstripTv: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueLightstripTv"]},{"name":"val HuePlay: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HuePlay","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-play.html","searchKeys":["HuePlay","val HuePlay: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HuePlay"]},{"name":"val HueSigne: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueSigne","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-signe.html","searchKeys":["HueSigne","val HueSigne: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueSigne"]},{"name":"val HueTube: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.HueTube","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-hue-tube.html","searchKeys":["HueTube","val HueTube: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.HueTube"]},{"name":"val LargeGlobeBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.LargeGlobeBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-large-globe-bulb.html","searchKeys":["LargeGlobeBulb","val LargeGlobeBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.LargeGlobeBulb"]},{"name":"val LusterBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.LusterBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-luster-bulb.html","searchKeys":["LusterBulb","val LusterBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.LusterBulb"]},{"name":"val PendantLong: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantLong","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-pendant-long.html","searchKeys":["PendantLong","val PendantLong: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantLong"]},{"name":"val PendantRound: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantRound","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-pendant-round.html","searchKeys":["PendantRound","val PendantRound: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantRound"]},{"name":"val PendantSpot: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantSpot","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-pendant-spot.html","searchKeys":["PendantSpot","val PendantSpot: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.PendantSpot"]},{"name":"val Plug: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.Plug","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-plug.html","searchKeys":["Plug","val Plug: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.Plug"]},{"name":"val RecessedCeiling: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.RecessedCeiling","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-recessed-ceiling.html","searchKeys":["RecessedCeiling","val RecessedCeiling: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.RecessedCeiling"]},{"name":"val RecessedFloor: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.RecessedFloor","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-recessed-floor.html","searchKeys":["RecessedFloor","val RecessedFloor: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.RecessedFloor"]},{"name":"val SingleSpot: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.SingleSpot","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-single-spot.html","searchKeys":["SingleSpot","val SingleSpot: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.SingleSpot"]},{"name":"val SmallGlobeBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.SmallGlobeBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-small-globe-bulb.html","searchKeys":["SmallGlobeBulb","val SmallGlobeBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.SmallGlobeBulb"]},{"name":"val SpotBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.SpotBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-spot-bulb.html","searchKeys":["SpotBulb","val SpotBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.SpotBulb"]},{"name":"val StringLight: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.StringLight","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-string-light.html","searchKeys":["StringLight","val StringLight: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.StringLight"]},{"name":"val SultanBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.SultanBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-sultan-bulb.html","searchKeys":["SultanBulb","val SultanBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.SultanBulb"]},{"name":"val TableShade: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.TableShade","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-table-shade.html","searchKeys":["TableShade","val TableShade: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.TableShade"]},{"name":"val TableWash: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.TableWash","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-table-wash.html","searchKeys":["TableWash","val TableWash: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.TableWash"]},{"name":"val TriangleBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.TriangleBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-triangle-bulb.html","searchKeys":["TriangleBulb","val TriangleBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.TriangleBulb"]},{"name":"val UnknownArchetype: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.UnknownArchetype","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-unknown-archetype.html","searchKeys":["UnknownArchetype","val UnknownArchetype: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.UnknownArchetype"]},{"name":"val VintageBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.VintageBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-vintage-bulb.html","searchKeys":["VintageBulb","val VintageBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.VintageBulb"]},{"name":"val VintageCandleBulb: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.VintageCandleBulb","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-vintage-candle-bulb.html","searchKeys":["VintageCandleBulb","val VintageCandleBulb: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.VintageCandleBulb"]},{"name":"val WallLantern: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.WallLantern","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-wall-lantern.html","searchKeys":["WallLantern","val WallLantern: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.WallLantern"]},{"name":"val WallShade: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.WallShade","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-wall-shade.html","searchKeys":["WallShade","val WallShade: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.WallShade"]},{"name":"val WallSpot: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.WallSpot","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-wall-spot.html","searchKeys":["WallSpot","val WallSpot: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.WallSpot"]},{"name":"val WallWasher: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductArchetype.Companion.WallWasher","location":"devices/inkapplications.shade.devices.structures/-product-archetype/-companion/-wall-washer.html","searchKeys":["WallWasher","val WallWasher: ProductArchetype","inkapplications.shade.devices.structures.ProductArchetype.Companion.WallWasher"]},{"name":"val archetype: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductMetadata.archetype","location":"devices/inkapplications.shade.devices.structures/-product-metadata/archetype.html","searchKeys":["archetype","val archetype: ProductArchetype","inkapplications.shade.devices.structures.ProductMetadata.archetype"]},{"name":"val archetype: ProductArchetype?","description":"inkapplications.shade.devices.parameters.DeviceMetadataParameters.archetype","location":"devices/inkapplications.shade.devices.parameters/-device-metadata-parameters/archetype.html","searchKeys":["archetype","val archetype: ProductArchetype?","inkapplications.shade.devices.parameters.DeviceMetadataParameters.archetype"]},{"name":"val certified: Boolean","description":"inkapplications.shade.devices.structures.ProductData.certified","location":"devices/inkapplications.shade.devices.structures/-product-data/certified.html","searchKeys":["certified","val certified: Boolean","inkapplications.shade.devices.structures.ProductData.certified"]},{"name":"val devices: DeviceControls","description":"inkapplications.shade.devices.ShadeDevicesModule.devices","location":"devices/inkapplications.shade.devices/-shade-devices-module/devices.html","searchKeys":["devices","val devices: DeviceControls","inkapplications.shade.devices.ShadeDevicesModule.devices"]},{"name":"val hardwarePlatformType: HardwarePlatformType?","description":"inkapplications.shade.devices.structures.ProductData.hardwarePlatformType","location":"devices/inkapplications.shade.devices.structures/-product-data/hardware-platform-type.html","searchKeys":["hardwarePlatformType","val hardwarePlatformType: HardwarePlatformType?","inkapplications.shade.devices.structures.ProductData.hardwarePlatformType"]},{"name":"val id: ResourceId","description":"inkapplications.shade.devices.structures.Device.id","location":"devices/inkapplications.shade.devices.structures/-device/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.devices.structures.Device.id"]},{"name":"val key: String","description":"inkapplications.shade.devices.structures.ProductArchetype.key","location":"devices/inkapplications.shade.devices.structures/-product-archetype/key.html","searchKeys":["key","val key: String","inkapplications.shade.devices.structures.ProductArchetype.key"]},{"name":"val manufacturerName: String","description":"inkapplications.shade.devices.structures.ProductData.manufacturerName","location":"devices/inkapplications.shade.devices.structures/-product-data/manufacturer-name.html","searchKeys":["manufacturerName","val manufacturerName: String","inkapplications.shade.devices.structures.ProductData.manufacturerName"]},{"name":"val metadata: DeviceMetadataParameters?","description":"inkapplications.shade.devices.parameters.UpdateDeviceParameters.metadata","location":"devices/inkapplications.shade.devices.parameters/-update-device-parameters/metadata.html","searchKeys":["metadata","val metadata: DeviceMetadataParameters?","inkapplications.shade.devices.parameters.UpdateDeviceParameters.metadata"]},{"name":"val metadata: ProductMetadata","description":"inkapplications.shade.devices.structures.Device.metadata","location":"devices/inkapplications.shade.devices.structures/-device/metadata.html","searchKeys":["metadata","val metadata: ProductMetadata","inkapplications.shade.devices.structures.Device.metadata"]},{"name":"val modelId: ModelId","description":"inkapplications.shade.devices.structures.ProductData.modelId","location":"devices/inkapplications.shade.devices.structures/-product-data/model-id.html","searchKeys":["modelId","val modelId: ModelId","inkapplications.shade.devices.structures.ProductData.modelId"]},{"name":"val name: String","description":"inkapplications.shade.devices.structures.ProductMetadata.name","location":"devices/inkapplications.shade.devices.structures/-product-metadata/name.html","searchKeys":["name","val name: String","inkapplications.shade.devices.structures.ProductMetadata.name"]},{"name":"val name: String?","description":"inkapplications.shade.devices.parameters.DeviceMetadataParameters.name","location":"devices/inkapplications.shade.devices.parameters/-device-metadata-parameters/name.html","searchKeys":["name","val name: String?","inkapplications.shade.devices.parameters.DeviceMetadataParameters.name"]},{"name":"val productArchetype: ProductArchetype","description":"inkapplications.shade.devices.structures.ProductData.productArchetype","location":"devices/inkapplications.shade.devices.structures/-product-data/product-archetype.html","searchKeys":["productArchetype","val productArchetype: ProductArchetype","inkapplications.shade.devices.structures.ProductData.productArchetype"]},{"name":"val productData: ProductData","description":"inkapplications.shade.devices.structures.Device.productData","location":"devices/inkapplications.shade.devices.structures/-device/product-data.html","searchKeys":["productData","val productData: ProductData","inkapplications.shade.devices.structures.Device.productData"]},{"name":"val productName: String","description":"inkapplications.shade.devices.structures.ProductData.productName","location":"devices/inkapplications.shade.devices.structures/-product-data/product-name.html","searchKeys":["productName","val productName: String","inkapplications.shade.devices.structures.ProductData.productName"]},{"name":"val services: List","description":"inkapplications.shade.devices.structures.Device.services","location":"devices/inkapplications.shade.devices.structures/-device/services.html","searchKeys":["services","val services: List","inkapplications.shade.devices.structures.Device.services"]},{"name":"val softwareVersion: VersionString","description":"inkapplications.shade.devices.structures.ProductData.softwareVersion","location":"devices/inkapplications.shade.devices.structures/-product-data/software-version.html","searchKeys":["softwareVersion","val softwareVersion: VersionString","inkapplications.shade.devices.structures.ProductData.softwareVersion"]},{"name":"val v1Id: String?","description":"inkapplications.shade.devices.structures.Device.v1Id","location":"devices/inkapplications.shade.devices.structures/-device/v1-id.html","searchKeys":["v1Id","val v1Id: String?","inkapplications.shade.devices.structures.Device.v1Id"]},{"name":"val value: String","description":"inkapplications.shade.devices.structures.HardwarePlatformType.value","location":"devices/inkapplications.shade.devices.structures/-hardware-platform-type/value.html","searchKeys":["value","val value: String","inkapplications.shade.devices.structures.HardwarePlatformType.value"]},{"name":"val value: String","description":"inkapplications.shade.devices.structures.ModelId.value","location":"devices/inkapplications.shade.devices.structures/-model-id/value.html","searchKeys":["value","val value: String","inkapplications.shade.devices.structures.ModelId.value"]},{"name":"value class HardwarePlatformType(val value: String)","description":"inkapplications.shade.devices.structures.HardwarePlatformType","location":"devices/inkapplications.shade.devices.structures/-hardware-platform-type/index.html","searchKeys":["HardwarePlatformType","value class HardwarePlatformType(val value: String)","inkapplications.shade.devices.structures.HardwarePlatformType"]},{"name":"value class ModelId(val value: String)","description":"inkapplications.shade.devices.structures.ModelId","location":"devices/inkapplications.shade.devices.structures/-model-id/index.html","searchKeys":["ModelId","value class ModelId(val value: String)","inkapplications.shade.devices.structures.ModelId"]},{"name":"value class ProductArchetype(val key: String)","description":"inkapplications.shade.devices.structures.ProductArchetype","location":"devices/inkapplications.shade.devices.structures/-product-archetype/index.html","searchKeys":["ProductArchetype","value class ProductArchetype(val key: String)","inkapplications.shade.devices.structures.ProductArchetype"]},{"name":"abstract suspend fun setAuthToken(token: AuthToken?)","description":"inkapplications.shade.structures.HueConfigurationContainer.setAuthToken","location":"structures/inkapplications.shade.structures/-hue-configuration-container/set-auth-token.html","searchKeys":["setAuthToken","abstract suspend fun setAuthToken(token: AuthToken?)","inkapplications.shade.structures.HueConfigurationContainer.setAuthToken"]},{"name":"abstract suspend fun setHostname(hostname: String?)","description":"inkapplications.shade.structures.HueConfigurationContainer.setHostname","location":"structures/inkapplications.shade.structures/-hue-configuration-container/set-hostname.html","searchKeys":["setHostname","abstract suspend fun setHostname(hostname: String?)","inkapplications.shade.structures.HueConfigurationContainer.setHostname"]},{"name":"abstract suspend fun setSecurityStrategy(securityStrategy: SecurityStrategy)","description":"inkapplications.shade.structures.HueConfigurationContainer.setSecurityStrategy","location":"structures/inkapplications.shade.structures/-hue-configuration-container/set-security-strategy.html","searchKeys":["setSecurityStrategy","abstract suspend fun setSecurityStrategy(securityStrategy: SecurityStrategy)","inkapplications.shade.structures.HueConfigurationContainer.setSecurityStrategy"]},{"name":"abstract val authToken: StateFlow","description":"inkapplications.shade.structures.HueConfigurationContainer.authToken","location":"structures/inkapplications.shade.structures/-hue-configuration-container/auth-token.html","searchKeys":["authToken","abstract val authToken: StateFlow","inkapplications.shade.structures.HueConfigurationContainer.authToken"]},{"name":"abstract val hostname: StateFlow","description":"inkapplications.shade.structures.HueConfigurationContainer.hostname","location":"structures/inkapplications.shade.structures/-hue-configuration-container/hostname.html","searchKeys":["hostname","abstract val hostname: StateFlow","inkapplications.shade.structures.HueConfigurationContainer.hostname"]},{"name":"abstract val securityStrategy: StateFlow","description":"inkapplications.shade.structures.HueConfigurationContainer.securityStrategy","location":"structures/inkapplications.shade.structures/-hue-configuration-container/security-strategy.html","searchKeys":["securityStrategy","abstract val securityStrategy: StateFlow","inkapplications.shade.structures.HueConfigurationContainer.securityStrategy"]},{"name":"annotation class UndocumentedApi","description":"inkapplications.shade.structures.UndocumentedApi","location":"structures/inkapplications.shade.structures/-undocumented-api/index.html","searchKeys":["UndocumentedApi","annotation class UndocumentedApi","inkapplications.shade.structures.UndocumentedApi"]},{"name":"class ApiError(code: Int, errors: List) : ApiStatusError","description":"inkapplications.shade.structures.ApiError","location":"structures/inkapplications.shade.structures/-api-error/index.html","searchKeys":["ApiError","class ApiError(code: Int, errors: List) : ApiStatusError","inkapplications.shade.structures.ApiError"]},{"name":"class HueCa(ip: String, deviceId: String) : SecurityStrategy.CustomCa","description":"inkapplications.shade.structures.SecurityStrategy.HueCa","location":"structures/inkapplications.shade.structures/-security-strategy/-hue-ca/index.html","searchKeys":["HueCa","class HueCa(ip: String, deviceId: String) : SecurityStrategy.CustomCa","inkapplications.shade.structures.SecurityStrategy.HueCa"]},{"name":"class InMemoryConfigurationContainer(initialHostname: String? = null, initialAuthToken: AuthToken? = null, initialSecurityStrategy: SecurityStrategy = SecurityStrategy.PlatformTrust) : HueConfigurationContainer","description":"inkapplications.shade.structures.InMemoryConfigurationContainer","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/index.html","searchKeys":["InMemoryConfigurationContainer","class InMemoryConfigurationContainer(initialHostname: String? = null, initialAuthToken: AuthToken? = null, initialSecurityStrategy: SecurityStrategy = SecurityStrategy.PlatformTrust) : HueConfigurationContainer","inkapplications.shade.structures.InMemoryConfigurationContainer"]},{"name":"class Insecure(val hostname: String) : SecurityStrategy","description":"inkapplications.shade.structures.SecurityStrategy.Insecure","location":"structures/inkapplications.shade.structures/-security-strategy/-insecure/index.html","searchKeys":["Insecure","class Insecure(val hostname: String) : SecurityStrategy","inkapplications.shade.structures.SecurityStrategy.Insecure"]},{"name":"class InvalidConfigurationException(message: String) : UserError","description":"inkapplications.shade.structures.InvalidConfigurationException","location":"structures/inkapplications.shade.structures/-invalid-configuration-exception/index.html","searchKeys":["InvalidConfigurationException","class InvalidConfigurationException(message: String) : UserError","inkapplications.shade.structures.InvalidConfigurationException"]},{"name":"class NetworkException(message: String, cause: Throwable) : ShadeException","description":"inkapplications.shade.structures.NetworkException","location":"structures/inkapplications.shade.structures/-network-exception/index.html","searchKeys":["NetworkException","class NetworkException(message: String, cause: Throwable) : ShadeException","inkapplications.shade.structures.NetworkException"]},{"name":"class PropertiesFileConfiguration(file: File = File(\n System.getProperty(\"user.home\")\n .takeIf { it.isNullOrEmpty() == false },\n \".shade-cli.properties\"\n )) : HueConfigurationContainer","description":"inkapplications.shade.structures.PropertiesFileConfiguration","location":"structures/inkapplications.shade.structures/-properties-file-configuration/index.html","searchKeys":["PropertiesFileConfiguration","class PropertiesFileConfiguration(file: File = File(\n System.getProperty(\"user.home\")\n .takeIf { it.isNullOrEmpty() == false },\n \".shade-cli.properties\"\n )) : HueConfigurationContainer","inkapplications.shade.structures.PropertiesFileConfiguration"]},{"name":"class SerializationError(message: String, cause: Throwable?) : InternalErrorException","description":"inkapplications.shade.structures.SerializationError","location":"structures/inkapplications.shade.structures/-serialization-error/index.html","searchKeys":["SerializationError","class SerializationError(message: String, cause: Throwable?) : InternalErrorException","inkapplications.shade.structures.SerializationError"]},{"name":"class UnauthorizedException(cause: Throwable? = null) : ShadeException","description":"inkapplications.shade.structures.UnauthorizedException","location":"structures/inkapplications.shade.structures/-unauthorized-exception/index.html","searchKeys":["UnauthorizedException","class UnauthorizedException(cause: Throwable? = null) : ShadeException","inkapplications.shade.structures.UnauthorizedException"]},{"name":"class UnexpectedStateException(message: String, cause: Throwable? = null) : InternalErrorException","description":"inkapplications.shade.structures.UnexpectedStateException","location":"structures/inkapplications.shade.structures/-unexpected-state-exception/index.html","searchKeys":["UnexpectedStateException","class UnexpectedStateException(message: String, cause: Throwable? = null) : InternalErrorException","inkapplications.shade.structures.UnexpectedStateException"]},{"name":"constructor(applicationKey: String, clientKey: String? = null)","description":"inkapplications.shade.structures.AuthToken.AuthToken","location":"structures/inkapplications.shade.structures/-auth-token/-auth-token.html","searchKeys":["AuthToken","constructor(applicationKey: String, clientKey: String? = null)","inkapplications.shade.structures.AuthToken.AuthToken"]},{"name":"constructor(archetype: SegmentArchetype, name: String)","description":"inkapplications.shade.structures.SegmentMetadata.SegmentMetadata","location":"structures/inkapplications.shade.structures/-segment-metadata/-segment-metadata.html","searchKeys":["SegmentMetadata","constructor(archetype: SegmentArchetype, name: String)","inkapplications.shade.structures.SegmentMetadata.SegmentMetadata"]},{"name":"constructor(archetype: SegmentArchetype? = null, name: String? = null)","description":"inkapplications.shade.structures.SegmentMetadataUpdate.SegmentMetadataUpdate","location":"structures/inkapplications.shade.structures/-segment-metadata-update/-segment-metadata-update.html","searchKeys":["SegmentMetadataUpdate","constructor(archetype: SegmentArchetype? = null, name: String? = null)","inkapplications.shade.structures.SegmentMetadataUpdate.SegmentMetadataUpdate"]},{"name":"constructor(cause: Throwable? = null)","description":"inkapplications.shade.structures.UnauthorizedException.UnauthorizedException","location":"structures/inkapplications.shade.structures/-unauthorized-exception/-unauthorized-exception.html","searchKeys":["UnauthorizedException","constructor(cause: Throwable? = null)","inkapplications.shade.structures.UnauthorizedException.UnauthorizedException"]},{"name":"constructor(certificatePem: String, hostname: String, ip: String)","description":"inkapplications.shade.structures.SecurityStrategy.CustomCa.CustomCa","location":"structures/inkapplications.shade.structures/-security-strategy/-custom-ca/-custom-ca.html","searchKeys":["CustomCa","constructor(certificatePem: String, hostname: String, ip: String)","inkapplications.shade.structures.SecurityStrategy.CustomCa.CustomCa"]},{"name":"constructor(code: Int, errors: List)","description":"inkapplications.shade.structures.ApiError.ApiError","location":"structures/inkapplications.shade.structures/-api-error/-api-error.html","searchKeys":["ApiError","constructor(code: Int, errors: List)","inkapplications.shade.structures.ApiError.ApiError"]},{"name":"constructor(code: Int, message: String = \"API Responded with code \")","description":"inkapplications.shade.structures.ApiStatusError.ApiStatusError","location":"structures/inkapplications.shade.structures/-api-status-error/-api-status-error.html","searchKeys":["ApiStatusError","constructor(code: Int, message: String = \"API Responded with code \")","inkapplications.shade.structures.ApiStatusError.ApiStatusError"]},{"name":"constructor(file: File = File(\n System.getProperty(\"user.home\")\n .takeIf { it.isNullOrEmpty() == false },\n \".shade-cli.properties\"\n ))","description":"inkapplications.shade.structures.PropertiesFileConfiguration.PropertiesFileConfiguration","location":"structures/inkapplications.shade.structures/-properties-file-configuration/-properties-file-configuration.html","searchKeys":["PropertiesFileConfiguration","constructor(file: File = File(\n System.getProperty(\"user.home\")\n .takeIf { it.isNullOrEmpty() == false },\n \".shade-cli.properties\"\n ))","inkapplications.shade.structures.PropertiesFileConfiguration.PropertiesFileConfiguration"]},{"name":"constructor(full: String)","description":"inkapplications.shade.structures.VersionString.VersionString","location":"structures/inkapplications.shade.structures/-version-string/-version-string.html","searchKeys":["VersionString","constructor(full: String)","inkapplications.shade.structures.VersionString.VersionString"]},{"name":"constructor(hostname: String)","description":"inkapplications.shade.structures.SecurityStrategy.Insecure.Insecure","location":"structures/inkapplications.shade.structures/-security-strategy/-insecure/-insecure.html","searchKeys":["Insecure","constructor(hostname: String)","inkapplications.shade.structures.SecurityStrategy.Insecure.Insecure"]},{"name":"constructor(id: ResourceId, type: ResourceType)","description":"inkapplications.shade.structures.ResourceReference.ResourceReference","location":"structures/inkapplications.shade.structures/-resource-reference/-resource-reference.html","searchKeys":["ResourceReference","constructor(id: ResourceId, type: ResourceType)","inkapplications.shade.structures.ResourceReference.ResourceReference"]},{"name":"constructor(initialHostname: String? = null, initialAuthToken: AuthToken? = null, initialSecurityStrategy: SecurityStrategy = SecurityStrategy.PlatformTrust)","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.InMemoryConfigurationContainer","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/-in-memory-configuration-container.html","searchKeys":["InMemoryConfigurationContainer","constructor(initialHostname: String? = null, initialAuthToken: AuthToken? = null, initialSecurityStrategy: SecurityStrategy = SecurityStrategy.PlatformTrust)","inkapplications.shade.structures.InMemoryConfigurationContainer.InMemoryConfigurationContainer"]},{"name":"constructor(ip: String, deviceId: String)","description":"inkapplications.shade.structures.SecurityStrategy.HueCa.HueCa","location":"structures/inkapplications.shade.structures/-security-strategy/-hue-ca/-hue-ca.html","searchKeys":["HueCa","constructor(ip: String, deviceId: String)","inkapplications.shade.structures.SecurityStrategy.HueCa.HueCa"]},{"name":"constructor(key: String)","description":"inkapplications.shade.structures.ResourceType.ResourceType","location":"structures/inkapplications.shade.structures/-resource-type/-resource-type.html","searchKeys":["ResourceType","constructor(key: String)","inkapplications.shade.structures.ResourceType.ResourceType"]},{"name":"constructor(key: String)","description":"inkapplications.shade.structures.SegmentArchetype.SegmentArchetype","location":"structures/inkapplications.shade.structures/-segment-archetype/-segment-archetype.html","searchKeys":["SegmentArchetype","constructor(key: String)","inkapplications.shade.structures.SegmentArchetype.SegmentArchetype"]},{"name":"constructor(message: String)","description":"inkapplications.shade.structures.InvalidConfigurationException.InvalidConfigurationException","location":"structures/inkapplications.shade.structures/-invalid-configuration-exception/-invalid-configuration-exception.html","searchKeys":["InvalidConfigurationException","constructor(message: String)","inkapplications.shade.structures.InvalidConfigurationException.InvalidConfigurationException"]},{"name":"constructor(message: String, cause: Throwable)","description":"inkapplications.shade.structures.NetworkException.NetworkException","location":"structures/inkapplications.shade.structures/-network-exception/-network-exception.html","searchKeys":["NetworkException","constructor(message: String, cause: Throwable)","inkapplications.shade.structures.NetworkException.NetworkException"]},{"name":"constructor(message: String, cause: Throwable? = null)","description":"inkapplications.shade.structures.UnexpectedStateException.UnexpectedStateException","location":"structures/inkapplications.shade.structures/-unexpected-state-exception/-unexpected-state-exception.html","searchKeys":["UnexpectedStateException","constructor(message: String, cause: Throwable? = null)","inkapplications.shade.structures.UnexpectedStateException.UnexpectedStateException"]},{"name":"constructor(message: String, cause: Throwable?)","description":"inkapplications.shade.structures.SerializationError.SerializationError","location":"structures/inkapplications.shade.structures/-serialization-error/-serialization-error.html","searchKeys":["SerializationError","constructor(message: String, cause: Throwable?)","inkapplications.shade.structures.SerializationError.SerializationError"]},{"name":"constructor(on: Boolean)","description":"inkapplications.shade.structures.PowerInfo.PowerInfo","location":"structures/inkapplications.shade.structures/-power-info/-power-info.html","searchKeys":["PowerInfo","constructor(on: Boolean)","inkapplications.shade.structures.PowerInfo.PowerInfo"]},{"name":"constructor(on: Boolean)","description":"inkapplications.shade.structures.PowerValue.PowerValue","location":"structures/inkapplications.shade.structures/-power-value/-power-value.html","searchKeys":["PowerValue","constructor(on: Boolean)","inkapplications.shade.structures.PowerValue.PowerValue"]},{"name":"constructor(on: Boolean? = null)","description":"inkapplications.shade.structures.parameters.PowerParameters.PowerParameters","location":"structures/inkapplications.shade.structures.parameters/-power-parameters/-power-parameters.html","searchKeys":["PowerParameters","constructor(on: Boolean? = null)","inkapplications.shade.structures.parameters.PowerParameters.PowerParameters"]},{"name":"constructor(type: String, json: String)","description":"inkapplications.shade.structures.UnknownEvent.UnknownEvent","location":"structures/inkapplications.shade.structures/-unknown-event/-unknown-event.html","searchKeys":["UnknownEvent","constructor(type: String, json: String)","inkapplications.shade.structures.UnknownEvent.UnknownEvent"]},{"name":"constructor(value: String)","description":"inkapplications.shade.structures.ResourceId.ResourceId","location":"structures/inkapplications.shade.structures/-resource-id/-resource-id.html","searchKeys":["ResourceId","constructor(value: String)","inkapplications.shade.structures.ResourceId.ResourceId"]},{"name":"data class AuthToken(val applicationKey: String, val clientKey: String? = null)","description":"inkapplications.shade.structures.AuthToken","location":"structures/inkapplications.shade.structures/-auth-token/index.html","searchKeys":["AuthToken","data class AuthToken(val applicationKey: String, val clientKey: String? = null)","inkapplications.shade.structures.AuthToken"]},{"name":"data class PowerInfo(val on: Boolean)","description":"inkapplications.shade.structures.PowerInfo","location":"structures/inkapplications.shade.structures/-power-info/index.html","searchKeys":["PowerInfo","data class PowerInfo(val on: Boolean)","inkapplications.shade.structures.PowerInfo"]},{"name":"data class PowerParameters(val on: Boolean? = null)","description":"inkapplications.shade.structures.parameters.PowerParameters","location":"structures/inkapplications.shade.structures.parameters/-power-parameters/index.html","searchKeys":["PowerParameters","data class PowerParameters(val on: Boolean? = null)","inkapplications.shade.structures.parameters.PowerParameters"]},{"name":"data class PowerValue(val on: Boolean)","description":"inkapplications.shade.structures.PowerValue","location":"structures/inkapplications.shade.structures/-power-value/index.html","searchKeys":["PowerValue","data class PowerValue(val on: Boolean)","inkapplications.shade.structures.PowerValue"]},{"name":"data class ResourceReference(val id: ResourceId, val type: ResourceType)","description":"inkapplications.shade.structures.ResourceReference","location":"structures/inkapplications.shade.structures/-resource-reference/index.html","searchKeys":["ResourceReference","data class ResourceReference(val id: ResourceId, val type: ResourceType)","inkapplications.shade.structures.ResourceReference"]},{"name":"data class SegmentMetadata(val archetype: SegmentArchetype, val name: String)","description":"inkapplications.shade.structures.SegmentMetadata","location":"structures/inkapplications.shade.structures/-segment-metadata/index.html","searchKeys":["SegmentMetadata","data class SegmentMetadata(val archetype: SegmentArchetype, val name: String)","inkapplications.shade.structures.SegmentMetadata"]},{"name":"data class SegmentMetadataUpdate(val archetype: SegmentArchetype? = null, val name: String? = null)","description":"inkapplications.shade.structures.SegmentMetadataUpdate","location":"structures/inkapplications.shade.structures/-segment-metadata-update/index.html","searchKeys":["SegmentMetadataUpdate","data class SegmentMetadataUpdate(val archetype: SegmentArchetype? = null, val name: String? = null)","inkapplications.shade.structures.SegmentMetadataUpdate"]},{"name":"data class UnknownEvent(val type: String, val json: String)","description":"inkapplications.shade.structures.UnknownEvent","location":"structures/inkapplications.shade.structures/-unknown-event/index.html","searchKeys":["UnknownEvent","data class UnknownEvent(val type: String, val json: String)","inkapplications.shade.structures.UnknownEvent"]},{"name":"fun valueOf(key: String): ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.valueOf","location":"structures/inkapplications.shade.structures/-resource-type/-companion/value-of.html","searchKeys":["valueOf","fun valueOf(key: String): ResourceType","inkapplications.shade.structures.ResourceType.Companion.valueOf"]},{"name":"fun valueOf(key: String): SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.valueOf","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/value-of.html","searchKeys":["valueOf","fun valueOf(key: String): SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.valueOf"]},{"name":"fun values(): Array","description":"inkapplications.shade.structures.ResourceType.Companion.values","location":"structures/inkapplications.shade.structures/-resource-type/-companion/values.html","searchKeys":["values","fun values(): Array","inkapplications.shade.structures.ResourceType.Companion.values"]},{"name":"fun values(): Array","description":"inkapplications.shade.structures.SegmentArchetype.Companion.values","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/values.html","searchKeys":["values","fun values(): Array","inkapplications.shade.structures.SegmentArchetype.Companion.values"]},{"name":"interface HueConfigurationContainer","description":"inkapplications.shade.structures.HueConfigurationContainer","location":"structures/inkapplications.shade.structures/-hue-configuration-container/index.html","searchKeys":["HueConfigurationContainer","interface HueConfigurationContainer","inkapplications.shade.structures.HueConfigurationContainer"]},{"name":"object AuthorizationTimeoutException : ShadeException","description":"inkapplications.shade.structures.AuthorizationTimeoutException","location":"structures/inkapplications.shade.structures/-authorization-timeout-exception/index.html","searchKeys":["AuthorizationTimeoutException","object AuthorizationTimeoutException : ShadeException","inkapplications.shade.structures.AuthorizationTimeoutException"]},{"name":"object Companion","description":"inkapplications.shade.structures.ResourceType.Companion","location":"structures/inkapplications.shade.structures/-resource-type/-companion/index.html","searchKeys":["Companion","object Companion","inkapplications.shade.structures.ResourceType.Companion"]},{"name":"object Companion","description":"inkapplications.shade.structures.SegmentArchetype.Companion","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/index.html","searchKeys":["Companion","object Companion","inkapplications.shade.structures.SegmentArchetype.Companion"]},{"name":"object HostnameNotSetException : UserError","description":"inkapplications.shade.structures.HostnameNotSetException","location":"structures/inkapplications.shade.structures/-hostname-not-set-exception/index.html","searchKeys":["HostnameNotSetException","object HostnameNotSetException : UserError","inkapplications.shade.structures.HostnameNotSetException"]},{"name":"object PlatformTrust : SecurityStrategy","description":"inkapplications.shade.structures.SecurityStrategy.PlatformTrust","location":"structures/inkapplications.shade.structures/-security-strategy/-platform-trust/index.html","searchKeys":["PlatformTrust","object PlatformTrust : SecurityStrategy","inkapplications.shade.structures.SecurityStrategy.PlatformTrust"]},{"name":"open class ApiStatusError(val code: Int, message: String = \"API Responded with code \") : ShadeException","description":"inkapplications.shade.structures.ApiStatusError","location":"structures/inkapplications.shade.structures/-api-status-error/index.html","searchKeys":["ApiStatusError","open class ApiStatusError(val code: Int, message: String = \"API Responded with code \") : ShadeException","inkapplications.shade.structures.ApiStatusError"]},{"name":"open class CustomCa(val certificatePem: String, val hostname: String, val ip: String) : SecurityStrategy","description":"inkapplications.shade.structures.SecurityStrategy.CustomCa","location":"structures/inkapplications.shade.structures/-security-strategy/-custom-ca/index.html","searchKeys":["CustomCa","open class CustomCa(val certificatePem: String, val hostname: String, val ip: String) : SecurityStrategy","inkapplications.shade.structures.SecurityStrategy.CustomCa"]},{"name":"open class InternalErrorException : ShadeException","description":"inkapplications.shade.structures.InternalErrorException","location":"structures/inkapplications.shade.structures/-internal-error-exception/index.html","searchKeys":["InternalErrorException","open class InternalErrorException : ShadeException","inkapplications.shade.structures.InternalErrorException"]},{"name":"open class SecurityStrategy","description":"inkapplications.shade.structures.SecurityStrategy","location":"structures/inkapplications.shade.structures/-security-strategy/index.html","searchKeys":["SecurityStrategy","open class SecurityStrategy","inkapplications.shade.structures.SecurityStrategy"]},{"name":"open class ShadeException : RuntimeException","description":"inkapplications.shade.structures.ShadeException","location":"structures/inkapplications.shade.structures/-shade-exception/index.html","searchKeys":["ShadeException","open class ShadeException : RuntimeException","inkapplications.shade.structures.ShadeException"]},{"name":"open class UserError : ShadeException","description":"inkapplications.shade.structures.UserError","location":"structures/inkapplications.shade.structures/-user-error/index.html","searchKeys":["UserError","open class UserError : ShadeException","inkapplications.shade.structures.UserError"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.AuthToken.toString","location":"structures/inkapplications.shade.structures/-auth-token/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.AuthToken.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.ResourceId.toString","location":"structures/inkapplications.shade.structures/-resource-id/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.ResourceId.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.ResourceReference.toString","location":"structures/inkapplications.shade.structures/-resource-reference/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.ResourceReference.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.ResourceType.toString","location":"structures/inkapplications.shade.structures/-resource-type/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.ResourceType.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.SegmentArchetype.toString","location":"structures/inkapplications.shade.structures/-segment-archetype/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.SegmentArchetype.toString"]},{"name":"open override fun toString(): String","description":"inkapplications.shade.structures.VersionString.toString","location":"structures/inkapplications.shade.structures/-version-string/to-string.html","searchKeys":["toString","open override fun toString(): String","inkapplications.shade.structures.VersionString.toString"]},{"name":"open override val authToken: StateFlow","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.authToken","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/auth-token.html","searchKeys":["authToken","open override val authToken: StateFlow","inkapplications.shade.structures.InMemoryConfigurationContainer.authToken"]},{"name":"open override val authToken: StateFlow","description":"inkapplications.shade.structures.PropertiesFileConfiguration.authToken","location":"structures/inkapplications.shade.structures/-properties-file-configuration/auth-token.html","searchKeys":["authToken","open override val authToken: StateFlow","inkapplications.shade.structures.PropertiesFileConfiguration.authToken"]},{"name":"open override val hostname: StateFlow","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.hostname","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/hostname.html","searchKeys":["hostname","open override val hostname: StateFlow","inkapplications.shade.structures.InMemoryConfigurationContainer.hostname"]},{"name":"open override val hostname: StateFlow","description":"inkapplications.shade.structures.PropertiesFileConfiguration.hostname","location":"structures/inkapplications.shade.structures/-properties-file-configuration/hostname.html","searchKeys":["hostname","open override val hostname: StateFlow","inkapplications.shade.structures.PropertiesFileConfiguration.hostname"]},{"name":"open override val securityStrategy: StateFlow","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.securityStrategy","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/security-strategy.html","searchKeys":["securityStrategy","open override val securityStrategy: StateFlow","inkapplications.shade.structures.InMemoryConfigurationContainer.securityStrategy"]},{"name":"open override val securityStrategy: StateFlow","description":"inkapplications.shade.structures.PropertiesFileConfiguration.securityStrategy","location":"structures/inkapplications.shade.structures/-properties-file-configuration/security-strategy.html","searchKeys":["securityStrategy","open override val securityStrategy: StateFlow","inkapplications.shade.structures.PropertiesFileConfiguration.securityStrategy"]},{"name":"open suspend override fun setAuthToken(key: AuthToken?)","description":"inkapplications.shade.structures.PropertiesFileConfiguration.setAuthToken","location":"structures/inkapplications.shade.structures/-properties-file-configuration/set-auth-token.html","searchKeys":["setAuthToken","open suspend override fun setAuthToken(key: AuthToken?)","inkapplications.shade.structures.PropertiesFileConfiguration.setAuthToken"]},{"name":"open suspend override fun setAuthToken(token: AuthToken?)","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.setAuthToken","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/set-auth-token.html","searchKeys":["setAuthToken","open suspend override fun setAuthToken(token: AuthToken?)","inkapplications.shade.structures.InMemoryConfigurationContainer.setAuthToken"]},{"name":"open suspend override fun setHostname(hostname: String?)","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.setHostname","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/set-hostname.html","searchKeys":["setHostname","open suspend override fun setHostname(hostname: String?)","inkapplications.shade.structures.InMemoryConfigurationContainer.setHostname"]},{"name":"open suspend override fun setHostname(hostname: String?)","description":"inkapplications.shade.structures.PropertiesFileConfiguration.setHostname","location":"structures/inkapplications.shade.structures/-properties-file-configuration/set-hostname.html","searchKeys":["setHostname","open suspend override fun setHostname(hostname: String?)","inkapplications.shade.structures.PropertiesFileConfiguration.setHostname"]},{"name":"open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","description":"inkapplications.shade.structures.InMemoryConfigurationContainer.setSecurityStrategy","location":"structures/inkapplications.shade.structures/-in-memory-configuration-container/set-security-strategy.html","searchKeys":["setSecurityStrategy","open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","inkapplications.shade.structures.InMemoryConfigurationContainer.setSecurityStrategy"]},{"name":"open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","description":"inkapplications.shade.structures.PropertiesFileConfiguration.setSecurityStrategy","location":"structures/inkapplications.shade.structures/-properties-file-configuration/set-security-strategy.html","searchKeys":["setSecurityStrategy","open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","inkapplications.shade.structures.PropertiesFileConfiguration.setSecurityStrategy"]},{"name":"val Attic: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Attic","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-attic.html","searchKeys":["Attic","val Attic: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Attic"]},{"name":"val AuthV1: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.AuthV1","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-auth-v1.html","searchKeys":["AuthV1","val AuthV1: ResourceType","inkapplications.shade.structures.ResourceType.Companion.AuthV1"]},{"name":"val Balcony: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Balcony","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-balcony.html","searchKeys":["Balcony","val Balcony: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Balcony"]},{"name":"val Barbecue: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Barbecue","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-barbecue.html","searchKeys":["Barbecue","val Barbecue: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Barbecue"]},{"name":"val Bathroom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Bathroom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-bathroom.html","searchKeys":["Bathroom","val Bathroom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Bathroom"]},{"name":"val Bedroom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Bedroom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-bedroom.html","searchKeys":["Bedroom","val Bedroom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Bedroom"]},{"name":"val BehaviorInstance: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.BehaviorInstance","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-behavior-instance.html","searchKeys":["BehaviorInstance","val BehaviorInstance: ResourceType","inkapplications.shade.structures.ResourceType.Companion.BehaviorInstance"]},{"name":"val BehaviorScript: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.BehaviorScript","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-behavior-script.html","searchKeys":["BehaviorScript","val BehaviorScript: ResourceType","inkapplications.shade.structures.ResourceType.Companion.BehaviorScript"]},{"name":"val Bridge: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Bridge","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-bridge.html","searchKeys":["Bridge","val Bridge: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Bridge"]},{"name":"val BridgeHome: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.BridgeHome","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-bridge-home.html","searchKeys":["BridgeHome","val BridgeHome: ResourceType","inkapplications.shade.structures.ResourceType.Companion.BridgeHome"]},{"name":"val Button: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Button","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-button.html","searchKeys":["Button","val Button: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Button"]},{"name":"val Carport: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Carport","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-carport.html","searchKeys":["Carport","val Carport: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Carport"]},{"name":"val Closet: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Closet","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-closet.html","searchKeys":["Closet","val Closet: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Closet"]},{"name":"val Computer: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Computer","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-computer.html","searchKeys":["Computer","val Computer: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Computer"]},{"name":"val Device: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Device","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-device.html","searchKeys":["Device","val Device: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Device"]},{"name":"val DevicePower: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.DevicePower","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-device-power.html","searchKeys":["DevicePower","val DevicePower: ResourceType","inkapplications.shade.structures.ResourceType.Companion.DevicePower"]},{"name":"val Dining: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Dining","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-dining.html","searchKeys":["Dining","val Dining: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Dining"]},{"name":"val Downstairs: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Downstairs","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-downstairs.html","searchKeys":["Downstairs","val Downstairs: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Downstairs"]},{"name":"val Driveway: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Driveway","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-driveway.html","searchKeys":["Driveway","val Driveway: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Driveway"]},{"name":"val Entertainment: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Entertainment","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-entertainment.html","searchKeys":["Entertainment","val Entertainment: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Entertainment"]},{"name":"val EntertainmentConfiguration: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.EntertainmentConfiguration","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-entertainment-configuration.html","searchKeys":["EntertainmentConfiguration","val EntertainmentConfiguration: ResourceType","inkapplications.shade.structures.ResourceType.Companion.EntertainmentConfiguration"]},{"name":"val FrontDoor: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.FrontDoor","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-front-door.html","searchKeys":["FrontDoor","val FrontDoor: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.FrontDoor"]},{"name":"val Garage: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Garage","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-garage.html","searchKeys":["Garage","val Garage: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Garage"]},{"name":"val Garden: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Garden","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-garden.html","searchKeys":["Garden","val Garden: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Garden"]},{"name":"val Geofence: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Geofence","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-geofence.html","searchKeys":["Geofence","val Geofence: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Geofence"]},{"name":"val GeofenceClient: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.GeofenceClient","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-geofence-client.html","searchKeys":["GeofenceClient","val GeofenceClient: ResourceType","inkapplications.shade.structures.ResourceType.Companion.GeofenceClient"]},{"name":"val Geolocation: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Geolocation","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-geolocation.html","searchKeys":["Geolocation","val Geolocation: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Geolocation"]},{"name":"val GroupedLight: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.GroupedLight","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-grouped-light.html","searchKeys":["GroupedLight","val GroupedLight: ResourceType","inkapplications.shade.structures.ResourceType.Companion.GroupedLight"]},{"name":"val GuestRoom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.GuestRoom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-guest-room.html","searchKeys":["GuestRoom","val GuestRoom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.GuestRoom"]},{"name":"val Gym: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Gym","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-gym.html","searchKeys":["Gym","val Gym: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Gym"]},{"name":"val Hallway: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Hallway","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-hallway.html","searchKeys":["Hallway","val Hallway: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Hallway"]},{"name":"val Home: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Home","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-home.html","searchKeys":["Home","val Home: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Home"]},{"name":"val Homekit: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Homekit","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-homekit.html","searchKeys":["Homekit","val Homekit: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Homekit"]},{"name":"val KidsBedroom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.KidsBedroom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-kids-bedroom.html","searchKeys":["KidsBedroom","val KidsBedroom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.KidsBedroom"]},{"name":"val Kitchen: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Kitchen","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-kitchen.html","searchKeys":["Kitchen","val Kitchen: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Kitchen"]},{"name":"val LaundryRoom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.LaundryRoom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-laundry-room.html","searchKeys":["LaundryRoom","val LaundryRoom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.LaundryRoom"]},{"name":"val Light: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Light","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-light.html","searchKeys":["Light","val Light: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Light"]},{"name":"val LightLevel: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.LightLevel","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-light-level.html","searchKeys":["LightLevel","val LightLevel: ResourceType","inkapplications.shade.structures.ResourceType.Companion.LightLevel"]},{"name":"val LivingRoom: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.LivingRoom","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-living-room.html","searchKeys":["LivingRoom","val LivingRoom: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.LivingRoom"]},{"name":"val Lounge: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Lounge","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-lounge.html","searchKeys":["Lounge","val Lounge: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Lounge"]},{"name":"val ManCave: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.ManCave","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-man-cave.html","searchKeys":["ManCave","val ManCave: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.ManCave"]},{"name":"val Motion: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Motion","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-motion.html","searchKeys":["Motion","val Motion: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Motion"]},{"name":"val Music: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Music","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-music.html","searchKeys":["Music","val Music: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Music"]},{"name":"val Nursery: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Nursery","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-nursery.html","searchKeys":["Nursery","val Nursery: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Nursery"]},{"name":"val Office: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Office","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-office.html","searchKeys":["Office","val Office: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Office"]},{"name":"val Other: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Other","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-other.html","searchKeys":["Other","val Other: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Other"]},{"name":"val Pool: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Pool","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-pool.html","searchKeys":["Pool","val Pool: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Pool"]},{"name":"val Porch: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Porch","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-porch.html","searchKeys":["Porch","val Porch: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Porch"]},{"name":"val PublicImage: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.PublicImage","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-public-image.html","searchKeys":["PublicImage","val PublicImage: ResourceType","inkapplications.shade.structures.ResourceType.Companion.PublicImage"]},{"name":"val Reading: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Reading","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-reading.html","searchKeys":["Reading","val Reading: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Reading"]},{"name":"val Recreation: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Recreation","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-recreation.html","searchKeys":["Recreation","val Recreation: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Recreation"]},{"name":"val Room: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Room","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-room.html","searchKeys":["Room","val Room: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Room"]},{"name":"val Scene: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Scene","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-scene.html","searchKeys":["Scene","val Scene: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Scene"]},{"name":"val Staircase: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Staircase","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-staircase.html","searchKeys":["Staircase","val Staircase: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Staircase"]},{"name":"val Storage: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Storage","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-storage.html","searchKeys":["Storage","val Storage: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Storage"]},{"name":"val Studio: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Studio","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-studio.html","searchKeys":["Studio","val Studio: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Studio"]},{"name":"val Temperature: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Temperature","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-temperature.html","searchKeys":["Temperature","val Temperature: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Temperature"]},{"name":"val Terrace: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Terrace","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-terrace.html","searchKeys":["Terrace","val Terrace: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Terrace"]},{"name":"val Toilet: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Toilet","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-toilet.html","searchKeys":["Toilet","val Toilet: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Toilet"]},{"name":"val TopFloor: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.TopFloor","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-top-floor.html","searchKeys":["TopFloor","val TopFloor: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.TopFloor"]},{"name":"val Tv: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Tv","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-tv.html","searchKeys":["Tv","val Tv: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Tv"]},{"name":"val Upstairs: SegmentArchetype","description":"inkapplications.shade.structures.SegmentArchetype.Companion.Upstairs","location":"structures/inkapplications.shade.structures/-segment-archetype/-companion/-upstairs.html","searchKeys":["Upstairs","val Upstairs: SegmentArchetype","inkapplications.shade.structures.SegmentArchetype.Companion.Upstairs"]},{"name":"val ZgpConnectivity: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.ZgpConnectivity","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-zgp-connectivity.html","searchKeys":["ZgpConnectivity","val ZgpConnectivity: ResourceType","inkapplications.shade.structures.ResourceType.Companion.ZgpConnectivity"]},{"name":"val ZigbeeBridgeConnectivity: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.ZigbeeBridgeConnectivity","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-zigbee-bridge-connectivity.html","searchKeys":["ZigbeeBridgeConnectivity","val ZigbeeBridgeConnectivity: ResourceType","inkapplications.shade.structures.ResourceType.Companion.ZigbeeBridgeConnectivity"]},{"name":"val ZigbeeConnectivity: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.ZigbeeConnectivity","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-zigbee-connectivity.html","searchKeys":["ZigbeeConnectivity","val ZigbeeConnectivity: ResourceType","inkapplications.shade.structures.ResourceType.Companion.ZigbeeConnectivity"]},{"name":"val Zone: ResourceType","description":"inkapplications.shade.structures.ResourceType.Companion.Zone","location":"structures/inkapplications.shade.structures/-resource-type/-companion/-zone.html","searchKeys":["Zone","val Zone: ResourceType","inkapplications.shade.structures.ResourceType.Companion.Zone"]},{"name":"val applicationKey: String","description":"inkapplications.shade.structures.AuthToken.applicationKey","location":"structures/inkapplications.shade.structures/-auth-token/application-key.html","searchKeys":["applicationKey","val applicationKey: String","inkapplications.shade.structures.AuthToken.applicationKey"]},{"name":"val archetype: SegmentArchetype","description":"inkapplications.shade.structures.SegmentMetadata.archetype","location":"structures/inkapplications.shade.structures/-segment-metadata/archetype.html","searchKeys":["archetype","val archetype: SegmentArchetype","inkapplications.shade.structures.SegmentMetadata.archetype"]},{"name":"val archetype: SegmentArchetype?","description":"inkapplications.shade.structures.SegmentMetadataUpdate.archetype","location":"structures/inkapplications.shade.structures/-segment-metadata-update/archetype.html","searchKeys":["archetype","val archetype: SegmentArchetype?","inkapplications.shade.structures.SegmentMetadataUpdate.archetype"]},{"name":"val certificatePem: String","description":"inkapplications.shade.structures.SecurityStrategy.CustomCa.certificatePem","location":"structures/inkapplications.shade.structures/-security-strategy/-custom-ca/certificate-pem.html","searchKeys":["certificatePem","val certificatePem: String","inkapplications.shade.structures.SecurityStrategy.CustomCa.certificatePem"]},{"name":"val clientKey: String?","description":"inkapplications.shade.structures.AuthToken.clientKey","location":"structures/inkapplications.shade.structures/-auth-token/client-key.html","searchKeys":["clientKey","val clientKey: String?","inkapplications.shade.structures.AuthToken.clientKey"]},{"name":"val code: Int","description":"inkapplications.shade.structures.ApiStatusError.code","location":"structures/inkapplications.shade.structures/-api-status-error/code.html","searchKeys":["code","val code: Int","inkapplications.shade.structures.ApiStatusError.code"]},{"name":"val full: String","description":"inkapplications.shade.structures.VersionString.full","location":"structures/inkapplications.shade.structures/-version-string/full.html","searchKeys":["full","val full: String","inkapplications.shade.structures.VersionString.full"]},{"name":"val hostname: String","description":"inkapplications.shade.structures.SecurityStrategy.CustomCa.hostname","location":"structures/inkapplications.shade.structures/-security-strategy/-custom-ca/hostname.html","searchKeys":["hostname","val hostname: String","inkapplications.shade.structures.SecurityStrategy.CustomCa.hostname"]},{"name":"val hostname: String","description":"inkapplications.shade.structures.SecurityStrategy.Insecure.hostname","location":"structures/inkapplications.shade.structures/-security-strategy/-insecure/hostname.html","searchKeys":["hostname","val hostname: String","inkapplications.shade.structures.SecurityStrategy.Insecure.hostname"]},{"name":"val id: ResourceId","description":"inkapplications.shade.structures.ResourceReference.id","location":"structures/inkapplications.shade.structures/-resource-reference/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.structures.ResourceReference.id"]},{"name":"val ip: String","description":"inkapplications.shade.structures.SecurityStrategy.CustomCa.ip","location":"structures/inkapplications.shade.structures/-security-strategy/-custom-ca/ip.html","searchKeys":["ip","val ip: String","inkapplications.shade.structures.SecurityStrategy.CustomCa.ip"]},{"name":"val json: String","description":"inkapplications.shade.structures.UnknownEvent.json","location":"structures/inkapplications.shade.structures/-unknown-event/json.html","searchKeys":["json","val json: String","inkapplications.shade.structures.UnknownEvent.json"]},{"name":"val key: String","description":"inkapplications.shade.structures.ResourceType.key","location":"structures/inkapplications.shade.structures/-resource-type/key.html","searchKeys":["key","val key: String","inkapplications.shade.structures.ResourceType.key"]},{"name":"val key: String","description":"inkapplications.shade.structures.SegmentArchetype.key","location":"structures/inkapplications.shade.structures/-segment-archetype/key.html","searchKeys":["key","val key: String","inkapplications.shade.structures.SegmentArchetype.key"]},{"name":"val major: MatchGroup?","description":"inkapplications.shade.structures.VersionString.major","location":"structures/inkapplications.shade.structures/-version-string/major.html","searchKeys":["major","val major: MatchGroup?","inkapplications.shade.structures.VersionString.major"]},{"name":"val minor: MatchGroup?","description":"inkapplications.shade.structures.VersionString.minor","location":"structures/inkapplications.shade.structures/-version-string/minor.html","searchKeys":["minor","val minor: MatchGroup?","inkapplications.shade.structures.VersionString.minor"]},{"name":"val name: String","description":"inkapplications.shade.structures.SegmentMetadata.name","location":"structures/inkapplications.shade.structures/-segment-metadata/name.html","searchKeys":["name","val name: String","inkapplications.shade.structures.SegmentMetadata.name"]},{"name":"val name: String?","description":"inkapplications.shade.structures.SegmentMetadataUpdate.name","location":"structures/inkapplications.shade.structures/-segment-metadata-update/name.html","searchKeys":["name","val name: String?","inkapplications.shade.structures.SegmentMetadataUpdate.name"]},{"name":"val on: Boolean","description":"inkapplications.shade.structures.PowerInfo.on","location":"structures/inkapplications.shade.structures/-power-info/on.html","searchKeys":["on","val on: Boolean","inkapplications.shade.structures.PowerInfo.on"]},{"name":"val on: Boolean","description":"inkapplications.shade.structures.PowerValue.on","location":"structures/inkapplications.shade.structures/-power-value/on.html","searchKeys":["on","val on: Boolean","inkapplications.shade.structures.PowerValue.on"]},{"name":"val on: Boolean?","description":"inkapplications.shade.structures.parameters.PowerParameters.on","location":"structures/inkapplications.shade.structures.parameters/-power-parameters/on.html","searchKeys":["on","val on: Boolean?","inkapplications.shade.structures.parameters.PowerParameters.on"]},{"name":"val patch: MatchGroup?","description":"inkapplications.shade.structures.VersionString.patch","location":"structures/inkapplications.shade.structures/-version-string/patch.html","searchKeys":["patch","val patch: MatchGroup?","inkapplications.shade.structures.VersionString.patch"]},{"name":"val type: ResourceType","description":"inkapplications.shade.structures.ResourceReference.type","location":"structures/inkapplications.shade.structures/-resource-reference/type.html","searchKeys":["type","val type: ResourceType","inkapplications.shade.structures.ResourceReference.type"]},{"name":"val type: String","description":"inkapplications.shade.structures.UnknownEvent.type","location":"structures/inkapplications.shade.structures/-unknown-event/type.html","searchKeys":["type","val type: String","inkapplications.shade.structures.UnknownEvent.type"]},{"name":"val value: String","description":"inkapplications.shade.structures.ResourceId.value","location":"structures/inkapplications.shade.structures/-resource-id/value.html","searchKeys":["value","val value: String","inkapplications.shade.structures.ResourceId.value"]},{"name":"value class ResourceId(val value: String)","description":"inkapplications.shade.structures.ResourceId","location":"structures/inkapplications.shade.structures/-resource-id/index.html","searchKeys":["ResourceId","value class ResourceId(val value: String)","inkapplications.shade.structures.ResourceId"]},{"name":"value class ResourceType(val key: String)","description":"inkapplications.shade.structures.ResourceType","location":"structures/inkapplications.shade.structures/-resource-type/index.html","searchKeys":["ResourceType","value class ResourceType(val key: String)","inkapplications.shade.structures.ResourceType"]},{"name":"value class SegmentArchetype(val key: String)","description":"inkapplications.shade.structures.SegmentArchetype","location":"structures/inkapplications.shade.structures/-segment-archetype/index.html","searchKeys":["SegmentArchetype","value class SegmentArchetype(val key: String)","inkapplications.shade.structures.SegmentArchetype"]},{"name":"value class VersionString(val full: String)","description":"inkapplications.shade.structures.VersionString","location":"structures/inkapplications.shade.structures/-version-string/index.html","searchKeys":["VersionString","value class VersionString(val full: String)","inkapplications.shade.structures.VersionString"]},{"name":"abstract suspend fun listResources(): List","description":"inkapplications.shade.resources.ResourceControls.listResources","location":"resources/inkapplications.shade.resources/-resource-controls/list-resources.html","searchKeys":["listResources","abstract suspend fun listResources(): List","inkapplications.shade.resources.ResourceControls.listResources"]},{"name":"class ShadeResourcesModule(internalsModule: InternalsModule)","description":"inkapplications.shade.resources.ShadeResourcesModule","location":"resources/inkapplications.shade.resources/-shade-resources-module/index.html","searchKeys":["ShadeResourcesModule","class ShadeResourcesModule(internalsModule: InternalsModule)","inkapplications.shade.resources.ShadeResourcesModule"]},{"name":"constructor(id: ResourceId, type: ResourceType? = null, v1Id: String? = null)","description":"inkapplications.shade.resources.structures.Resource.Resource","location":"resources/inkapplications.shade.resources.structures/-resource/-resource.html","searchKeys":["Resource","constructor(id: ResourceId, type: ResourceType? = null, v1Id: String? = null)","inkapplications.shade.resources.structures.Resource.Resource"]},{"name":"constructor(internalsModule: InternalsModule)","description":"inkapplications.shade.resources.ShadeResourcesModule.ShadeResourcesModule","location":"resources/inkapplications.shade.resources/-shade-resources-module/-shade-resources-module.html","searchKeys":["ShadeResourcesModule","constructor(internalsModule: InternalsModule)","inkapplications.shade.resources.ShadeResourcesModule.ShadeResourcesModule"]},{"name":"data class Resource(val id: ResourceId, val type: ResourceType? = null, val v1Id: String? = null)","description":"inkapplications.shade.resources.structures.Resource","location":"resources/inkapplications.shade.resources.structures/-resource/index.html","searchKeys":["Resource","data class Resource(val id: ResourceId, val type: ResourceType? = null, val v1Id: String? = null)","inkapplications.shade.resources.structures.Resource"]},{"name":"interface ResourceControls","description":"inkapplications.shade.resources.ResourceControls","location":"resources/inkapplications.shade.resources/-resource-controls/index.html","searchKeys":["ResourceControls","interface ResourceControls","inkapplications.shade.resources.ResourceControls"]},{"name":"val id: ResourceId","description":"inkapplications.shade.resources.structures.Resource.id","location":"resources/inkapplications.shade.resources.structures/-resource/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.resources.structures.Resource.id"]},{"name":"val resources: ResourceControls","description":"inkapplications.shade.resources.ShadeResourcesModule.resources","location":"resources/inkapplications.shade.resources/-shade-resources-module/resources.html","searchKeys":["resources","val resources: ResourceControls","inkapplications.shade.resources.ShadeResourcesModule.resources"]},{"name":"val type: ResourceType?","description":"inkapplications.shade.resources.structures.Resource.type","location":"resources/inkapplications.shade.resources.structures/-resource/type.html","searchKeys":["type","val type: ResourceType?","inkapplications.shade.resources.structures.Resource.type"]},{"name":"val v1Id: String?","description":"inkapplications.shade.resources.structures.Resource.v1Id","location":"resources/inkapplications.shade.resources.structures/-resource/v1-id.html","searchKeys":["v1Id","val v1Id: String?","inkapplications.shade.resources.structures.Resource.v1Id"]},{"name":"abstract suspend fun createZone(parameters: ZoneCreateParameters): ResourceReference","description":"inkapplications.shade.zones.ZoneControls.createZone","location":"zones/inkapplications.shade.zones/-zone-controls/create-zone.html","searchKeys":["createZone","abstract suspend fun createZone(parameters: ZoneCreateParameters): ResourceReference","inkapplications.shade.zones.ZoneControls.createZone"]},{"name":"abstract suspend fun deleteZone(id: ResourceId): ResourceReference","description":"inkapplications.shade.zones.ZoneControls.deleteZone","location":"zones/inkapplications.shade.zones/-zone-controls/delete-zone.html","searchKeys":["deleteZone","abstract suspend fun deleteZone(id: ResourceId): ResourceReference","inkapplications.shade.zones.ZoneControls.deleteZone"]},{"name":"abstract suspend fun getZone(id: ResourceId): Zone","description":"inkapplications.shade.zones.ZoneControls.getZone","location":"zones/inkapplications.shade.zones/-zone-controls/get-zone.html","searchKeys":["getZone","abstract suspend fun getZone(id: ResourceId): Zone","inkapplications.shade.zones.ZoneControls.getZone"]},{"name":"abstract suspend fun listZones(): List","description":"inkapplications.shade.zones.ZoneControls.listZones","location":"zones/inkapplications.shade.zones/-zone-controls/list-zones.html","searchKeys":["listZones","abstract suspend fun listZones(): List","inkapplications.shade.zones.ZoneControls.listZones"]},{"name":"abstract suspend fun updateZone(id: ResourceId, parameters: ZoneUpdateParameters): ResourceReference","description":"inkapplications.shade.zones.ZoneControls.updateZone","location":"zones/inkapplications.shade.zones/-zone-controls/update-zone.html","searchKeys":["updateZone","abstract suspend fun updateZone(id: ResourceId, parameters: ZoneUpdateParameters): ResourceReference","inkapplications.shade.zones.ZoneControls.updateZone"]},{"name":"class ShadeZonesModule(internalsModule: InternalsModule)","description":"inkapplications.shade.zones.ShadeZonesModule","location":"zones/inkapplications.shade.zones/-shade-zones-module/index.html","searchKeys":["ShadeZonesModule","class ShadeZonesModule(internalsModule: InternalsModule)","inkapplications.shade.zones.ShadeZonesModule"]},{"name":"constructor(id: ResourceId, services: List, metadata: SegmentMetadata, children: List)","description":"inkapplications.shade.zones.structures.Zone.Zone","location":"zones/inkapplications.shade.zones.structures/-zone/-zone.html","searchKeys":["Zone","constructor(id: ResourceId, services: List, metadata: SegmentMetadata, children: List)","inkapplications.shade.zones.structures.Zone.Zone"]},{"name":"constructor(internalsModule: InternalsModule)","description":"inkapplications.shade.zones.ShadeZonesModule.ShadeZonesModule","location":"zones/inkapplications.shade.zones/-shade-zones-module/-shade-zones-module.html","searchKeys":["ShadeZonesModule","constructor(internalsModule: InternalsModule)","inkapplications.shade.zones.ShadeZonesModule.ShadeZonesModule"]},{"name":"constructor(metadata: SegmentMetadata, children: List)","description":"inkapplications.shade.zones.parameters.ZoneCreateParameters.ZoneCreateParameters","location":"zones/inkapplications.shade.zones.parameters/-zone-create-parameters/-zone-create-parameters.html","searchKeys":["ZoneCreateParameters","constructor(metadata: SegmentMetadata, children: List)","inkapplications.shade.zones.parameters.ZoneCreateParameters.ZoneCreateParameters"]},{"name":"constructor(metadata: SegmentMetadataUpdate? = null, children: List? = null)","description":"inkapplications.shade.zones.parameters.ZoneUpdateParameters.ZoneUpdateParameters","location":"zones/inkapplications.shade.zones.parameters/-zone-update-parameters/-zone-update-parameters.html","searchKeys":["ZoneUpdateParameters","constructor(metadata: SegmentMetadataUpdate? = null, children: List? = null)","inkapplications.shade.zones.parameters.ZoneUpdateParameters.ZoneUpdateParameters"]},{"name":"data class Zone(val id: ResourceId, val services: List, val metadata: SegmentMetadata, val children: List)","description":"inkapplications.shade.zones.structures.Zone","location":"zones/inkapplications.shade.zones.structures/-zone/index.html","searchKeys":["Zone","data class Zone(val id: ResourceId, val services: List, val metadata: SegmentMetadata, val children: List)","inkapplications.shade.zones.structures.Zone"]},{"name":"data class ZoneCreateParameters(val metadata: SegmentMetadata, val children: List)","description":"inkapplications.shade.zones.parameters.ZoneCreateParameters","location":"zones/inkapplications.shade.zones.parameters/-zone-create-parameters/index.html","searchKeys":["ZoneCreateParameters","data class ZoneCreateParameters(val metadata: SegmentMetadata, val children: List)","inkapplications.shade.zones.parameters.ZoneCreateParameters"]},{"name":"data class ZoneUpdateParameters(val metadata: SegmentMetadataUpdate? = null, val children: List? = null)","description":"inkapplications.shade.zones.parameters.ZoneUpdateParameters","location":"zones/inkapplications.shade.zones.parameters/-zone-update-parameters/index.html","searchKeys":["ZoneUpdateParameters","data class ZoneUpdateParameters(val metadata: SegmentMetadataUpdate? = null, val children: List? = null)","inkapplications.shade.zones.parameters.ZoneUpdateParameters"]},{"name":"interface ZoneControls","description":"inkapplications.shade.zones.ZoneControls","location":"zones/inkapplications.shade.zones/-zone-controls/index.html","searchKeys":["ZoneControls","interface ZoneControls","inkapplications.shade.zones.ZoneControls"]},{"name":"val children: List","description":"inkapplications.shade.zones.parameters.ZoneCreateParameters.children","location":"zones/inkapplications.shade.zones.parameters/-zone-create-parameters/children.html","searchKeys":["children","val children: List","inkapplications.shade.zones.parameters.ZoneCreateParameters.children"]},{"name":"val children: List","description":"inkapplications.shade.zones.structures.Zone.children","location":"zones/inkapplications.shade.zones.structures/-zone/children.html","searchKeys":["children","val children: List","inkapplications.shade.zones.structures.Zone.children"]},{"name":"val children: List?","description":"inkapplications.shade.zones.parameters.ZoneUpdateParameters.children","location":"zones/inkapplications.shade.zones.parameters/-zone-update-parameters/children.html","searchKeys":["children","val children: List?","inkapplications.shade.zones.parameters.ZoneUpdateParameters.children"]},{"name":"val id: ResourceId","description":"inkapplications.shade.zones.structures.Zone.id","location":"zones/inkapplications.shade.zones.structures/-zone/id.html","searchKeys":["id","val id: ResourceId","inkapplications.shade.zones.structures.Zone.id"]},{"name":"val metadata: SegmentMetadata","description":"inkapplications.shade.zones.parameters.ZoneCreateParameters.metadata","location":"zones/inkapplications.shade.zones.parameters/-zone-create-parameters/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadata","inkapplications.shade.zones.parameters.ZoneCreateParameters.metadata"]},{"name":"val metadata: SegmentMetadata","description":"inkapplications.shade.zones.structures.Zone.metadata","location":"zones/inkapplications.shade.zones.structures/-zone/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadata","inkapplications.shade.zones.structures.Zone.metadata"]},{"name":"val metadata: SegmentMetadataUpdate?","description":"inkapplications.shade.zones.parameters.ZoneUpdateParameters.metadata","location":"zones/inkapplications.shade.zones.parameters/-zone-update-parameters/metadata.html","searchKeys":["metadata","val metadata: SegmentMetadataUpdate?","inkapplications.shade.zones.parameters.ZoneUpdateParameters.metadata"]},{"name":"val services: List","description":"inkapplications.shade.zones.structures.Zone.services","location":"zones/inkapplications.shade.zones.structures/-zone/services.html","searchKeys":["services","val services: List","inkapplications.shade.zones.structures.Zone.services"]},{"name":"val zones: ZoneControls","description":"inkapplications.shade.zones.ShadeZonesModule.zones","location":"zones/inkapplications.shade.zones/-shade-zones-module/zones.html","searchKeys":["zones","val zones: ZoneControls","inkapplications.shade.zones.ShadeZonesModule.zones"]},{"name":"abstract fun openSse(pathSegments: Array, dataDeserializer: DeserializationStrategy): Flow","description":"inkapplications.shade.internals.SseClient.openSse","location":"internals/inkapplications.shade.internals/-sse-client/open-sse.html","searchKeys":["openSse","abstract fun openSse(pathSegments: Array, dataDeserializer: DeserializationStrategy): Flow","inkapplications.shade.internals.SseClient.openSse"]},{"name":"abstract suspend fun sendRequest(method: String, pathSegments: Array, responseSerializer: KSerializer>, body: REQUEST? = null, requestSerializer: KSerializer? = null): RESPONSE","description":"inkapplications.shade.internals.HueHttpClient.sendRequest","location":"internals/inkapplications.shade.internals/-hue-http-client/send-request.html","searchKeys":["sendRequest","abstract suspend fun sendRequest(method: String, pathSegments: Array, responseSerializer: KSerializer>, body: REQUEST? = null, requestSerializer: KSerializer? = null): RESPONSE","inkapplications.shade.internals.HueHttpClient.sendRequest"]},{"name":"abstract suspend fun sendV1Request(method: String, pathSegments: Array, responseSerializer: KSerializer>>, body: REQUEST? = null, requestSerializer: KSerializer? = null): RESPONSE","description":"inkapplications.shade.internals.HueHttpClient.sendV1Request","location":"internals/inkapplications.shade.internals/-hue-http-client/send-v1-request.html","searchKeys":["sendV1Request","abstract suspend fun sendV1Request(method: String, pathSegments: Array, responseSerializer: KSerializer>>, body: REQUEST? = null, requestSerializer: KSerializer? = null): RESPONSE","inkapplications.shade.internals.HueHttpClient.sendV1Request"]},{"name":"actual constructor(configurationContainer: ERROR CLASS: Symbol not found for HueConfigurationContainer, json: ERROR CLASS: Symbol not found for Json, logger: ERROR CLASS: Symbol not found for KimchiLogger)","description":"inkapplications.shade.internals.PlatformModule.PlatformModule","location":"internals/inkapplications.shade.internals/-platform-module/-platform-module.html","searchKeys":["PlatformModule","actual constructor(configurationContainer: ERROR CLASS: Symbol not found for HueConfigurationContainer, json: ERROR CLASS: Symbol not found for Json, logger: ERROR CLASS: Symbol not found for KimchiLogger)","inkapplications.shade.internals.PlatformModule.PlatformModule"]},{"name":"actual fun createEngine(securityStrategy: ERROR CLASS: Symbol not found for SecurityStrategy): ERROR CLASS: Symbol not found for HttpClientEngineFactory<*>","description":"inkapplications.shade.internals.PlatformModule.createEngine","location":"internals/inkapplications.shade.internals/-platform-module/create-engine.html","searchKeys":["createEngine","actual fun createEngine(securityStrategy: ERROR CLASS: Symbol not found for SecurityStrategy): ERROR CLASS: Symbol not found for HttpClientEngineFactory<*>","inkapplications.shade.internals.PlatformModule.createEngine"]},{"name":"class CachedProperty(val keyProperty: () -> KEY, lazy: Boolean = false, val factory: (KEY) -> VALUE) : ReadOnlyProperty ","description":"inkapplications.shade.internals.CachedProperty","location":"internals/inkapplications.shade.internals/-cached-property/index.html","searchKeys":["CachedProperty","class CachedProperty(val keyProperty: () -> KEY, lazy: Boolean = false, val factory: (KEY) -> VALUE) : ReadOnlyProperty ","inkapplications.shade.internals.CachedProperty"]},{"name":"class InternalsModule(val configurationContainer: HueConfigurationContainer, logger: KimchiLogger = EmptyLogger)","description":"inkapplications.shade.internals.InternalsModule","location":"internals/inkapplications.shade.internals/-internals-module/index.html","searchKeys":["InternalsModule","class InternalsModule(val configurationContainer: HueConfigurationContainer, logger: KimchiLogger = EmptyLogger)","inkapplications.shade.internals.InternalsModule"]},{"name":"constructor(configurationContainer: HueConfigurationContainer, logger: KimchiLogger = EmptyLogger)","description":"inkapplications.shade.internals.InternalsModule.InternalsModule","location":"internals/inkapplications.shade.internals/-internals-module/-internals-module.html","searchKeys":["InternalsModule","constructor(configurationContainer: HueConfigurationContainer, logger: KimchiLogger = EmptyLogger)","inkapplications.shade.internals.InternalsModule.InternalsModule"]},{"name":"constructor(keyProperty: () -> KEY, lazy: Boolean = false, factory: (KEY) -> VALUE)","description":"inkapplications.shade.internals.CachedProperty.CachedProperty","location":"internals/inkapplications.shade.internals/-cached-property/-cached-property.html","searchKeys":["CachedProperty","constructor(keyProperty: () -> KEY, lazy: Boolean = false, factory: (KEY) -> VALUE)","inkapplications.shade.internals.CachedProperty.CachedProperty"]},{"name":"expect class PlatformModule","description":"inkapplications.shade.internals.PlatformModule","location":"internals/inkapplications.shade.internals/-platform-module/index.html","searchKeys":["PlatformModule","expect class PlatformModule","inkapplications.shade.internals.PlatformModule"]},{"name":"expect constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger = EmptyLogger)","description":"inkapplications.shade.internals.PlatformModule.PlatformModule","location":"internals/inkapplications.shade.internals/-platform-module/-platform-module.html","searchKeys":["PlatformModule","expect constructor(configurationContainer: HueConfigurationContainer, json: Json, logger: KimchiLogger = EmptyLogger)","inkapplications.shade.internals.PlatformModule.PlatformModule"]},{"name":"expect fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>","description":"inkapplications.shade.internals.PlatformModule.createEngine","location":"internals/inkapplications.shade.internals/-platform-module/create-engine.html","searchKeys":["createEngine","expect fun createEngine(securityStrategy: SecurityStrategy): HttpClientEngineFactory<*>","inkapplications.shade.internals.PlatformModule.createEngine"]},{"name":"fun applyPlatformConfiguration(builder: OkHttpClient.Builder, securityStrategy: SecurityStrategy): OkHttpClient.Builder","description":"inkapplications.shade.internals.PlatformModule.applyPlatformConfiguration","location":"internals/inkapplications.shade.internals/-platform-module/apply-platform-configuration.html","searchKeys":["applyPlatformConfiguration","fun applyPlatformConfiguration(builder: OkHttpClient.Builder, securityStrategy: SecurityStrategy): OkHttpClient.Builder","inkapplications.shade.internals.PlatformModule.applyPlatformConfiguration"]},{"name":"inline suspend fun HueHttpClient.postData(body: REQUEST, vararg pathSegments: String): RESPONSE","description":"inkapplications.shade.internals.postData","location":"internals/inkapplications.shade.internals/post-data.html","searchKeys":["postData","inline suspend fun HueHttpClient.postData(body: REQUEST, vararg pathSegments: String): RESPONSE","inkapplications.shade.internals.postData"]},{"name":"inline suspend fun HueHttpClient.putData(body: REQUEST, vararg pathSegments: String): RESPONSE","description":"inkapplications.shade.internals.putData","location":"internals/inkapplications.shade.internals/put-data.html","searchKeys":["putData","inline suspend fun HueHttpClient.putData(body: REQUEST, vararg pathSegments: String): RESPONSE","inkapplications.shade.internals.putData"]},{"name":"inline suspend fun HueHttpClient.deleteData(vararg pathSegments: String): T","description":"inkapplications.shade.internals.deleteData","location":"internals/inkapplications.shade.internals/delete-data.html","searchKeys":["deleteData","inline suspend fun HueHttpClient.deleteData(vararg pathSegments: String): T","inkapplications.shade.internals.deleteData"]},{"name":"inline suspend fun HueHttpClient.getData(vararg pathSegments: String): T","description":"inkapplications.shade.internals.getData","location":"internals/inkapplications.shade.internals/get-data.html","searchKeys":["getData","inline suspend fun HueHttpClient.getData(vararg pathSegments: String): T","inkapplications.shade.internals.getData"]},{"name":"interface HueHttpClient","description":"inkapplications.shade.internals.HueHttpClient","location":"internals/inkapplications.shade.internals/-hue-http-client/index.html","searchKeys":["HueHttpClient","interface HueHttpClient","inkapplications.shade.internals.HueHttpClient"]},{"name":"interface SseClient","description":"inkapplications.shade.internals.SseClient","location":"internals/inkapplications.shade.internals/-sse-client/index.html","searchKeys":["SseClient","interface SseClient","inkapplications.shade.internals.SseClient"]},{"name":"object DummyConfigurationContainer : HueConfigurationContainer","description":"inkapplications.shade.internals.DummyConfigurationContainer","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/index.html","searchKeys":["DummyConfigurationContainer","object DummyConfigurationContainer : HueConfigurationContainer","inkapplications.shade.internals.DummyConfigurationContainer"]},{"name":"object HueStubClient : HueHttpClient","description":"inkapplications.shade.internals.HueStubClient","location":"internals/inkapplications.shade.internals/-hue-stub-client/index.html","searchKeys":["HueStubClient","object HueStubClient : HueHttpClient","inkapplications.shade.internals.HueStubClient"]},{"name":"open operator override fun getValue(thisRef: Any?, property: KProperty<*>): VALUE","description":"inkapplications.shade.internals.CachedProperty.getValue","location":"internals/inkapplications.shade.internals/-cached-property/get-value.html","searchKeys":["getValue","open operator override fun getValue(thisRef: Any?, property: KProperty<*>): VALUE","inkapplications.shade.internals.CachedProperty.getValue"]},{"name":"open override val authToken: StateFlow","description":"inkapplications.shade.internals.DummyConfigurationContainer.authToken","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/auth-token.html","searchKeys":["authToken","open override val authToken: StateFlow","inkapplications.shade.internals.DummyConfigurationContainer.authToken"]},{"name":"open override val hostname: StateFlow","description":"inkapplications.shade.internals.DummyConfigurationContainer.hostname","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/hostname.html","searchKeys":["hostname","open override val hostname: StateFlow","inkapplications.shade.internals.DummyConfigurationContainer.hostname"]},{"name":"open override val securityStrategy: StateFlow","description":"inkapplications.shade.internals.DummyConfigurationContainer.securityStrategy","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/security-strategy.html","searchKeys":["securityStrategy","open override val securityStrategy: StateFlow","inkapplications.shade.internals.DummyConfigurationContainer.securityStrategy"]},{"name":"open suspend override fun sendRequest(method: String, pathSegments: Array, responseSerializer: KSerializer>, body: REQUEST?, requestSerializer: KSerializer?): RESPONSE","description":"inkapplications.shade.internals.HueStubClient.sendRequest","location":"internals/inkapplications.shade.internals/-hue-stub-client/send-request.html","searchKeys":["sendRequest","open suspend override fun sendRequest(method: String, pathSegments: Array, responseSerializer: KSerializer>, body: REQUEST?, requestSerializer: KSerializer?): RESPONSE","inkapplications.shade.internals.HueStubClient.sendRequest"]},{"name":"open suspend override fun sendV1Request(method: String, pathSegments: Array, responseSerializer: KSerializer>>, body: REQUEST?, requestSerializer: KSerializer?): RESPONSE","description":"inkapplications.shade.internals.HueStubClient.sendV1Request","location":"internals/inkapplications.shade.internals/-hue-stub-client/send-v1-request.html","searchKeys":["sendV1Request","open suspend override fun sendV1Request(method: String, pathSegments: Array, responseSerializer: KSerializer>>, body: REQUEST?, requestSerializer: KSerializer?): RESPONSE","inkapplications.shade.internals.HueStubClient.sendV1Request"]},{"name":"open suspend override fun setAuthToken(token: AuthToken?)","description":"inkapplications.shade.internals.DummyConfigurationContainer.setAuthToken","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/set-auth-token.html","searchKeys":["setAuthToken","open suspend override fun setAuthToken(token: AuthToken?)","inkapplications.shade.internals.DummyConfigurationContainer.setAuthToken"]},{"name":"open suspend override fun setHostname(hostname: String?)","description":"inkapplications.shade.internals.DummyConfigurationContainer.setHostname","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/set-hostname.html","searchKeys":["setHostname","open suspend override fun setHostname(hostname: String?)","inkapplications.shade.internals.DummyConfigurationContainer.setHostname"]},{"name":"open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","description":"inkapplications.shade.internals.DummyConfigurationContainer.setSecurityStrategy","location":"internals/inkapplications.shade.internals/-dummy-configuration-container/set-security-strategy.html","searchKeys":["setSecurityStrategy","open suspend override fun setSecurityStrategy(securityStrategy: SecurityStrategy)","inkapplications.shade.internals.DummyConfigurationContainer.setSecurityStrategy"]},{"name":"val configurationContainer: HueConfigurationContainer","description":"inkapplications.shade.internals.InternalsModule.configurationContainer","location":"internals/inkapplications.shade.internals/-internals-module/configuration-container.html","searchKeys":["configurationContainer","val configurationContainer: HueConfigurationContainer","inkapplications.shade.internals.InternalsModule.configurationContainer"]},{"name":"val factory: (KEY) -> VALUE","description":"inkapplications.shade.internals.CachedProperty.factory","location":"internals/inkapplications.shade.internals/-cached-property/factory.html","searchKeys":["factory","val factory: (KEY) -> VALUE","inkapplications.shade.internals.CachedProperty.factory"]},{"name":"val hueHttpClient: HueHttpClient","description":"inkapplications.shade.internals.InternalsModule.hueHttpClient","location":"internals/inkapplications.shade.internals/-internals-module/hue-http-client.html","searchKeys":["hueHttpClient","val hueHttpClient: HueHttpClient","inkapplications.shade.internals.InternalsModule.hueHttpClient"]},{"name":"val json: Json","description":"inkapplications.shade.internals.InternalsModule.json","location":"internals/inkapplications.shade.internals/-internals-module/json.html","searchKeys":["json","val json: Json","inkapplications.shade.internals.InternalsModule.json"]},{"name":"val keyProperty: () -> KEY","description":"inkapplications.shade.internals.CachedProperty.keyProperty","location":"internals/inkapplications.shade.internals/-cached-property/key-property.html","searchKeys":["keyProperty","val keyProperty: () -> KEY","inkapplications.shade.internals.CachedProperty.keyProperty"]},{"name":"val platformModule: PlatformModule","description":"inkapplications.shade.internals.InternalsModule.platformModule","location":"internals/inkapplications.shade.internals/-internals-module/platform-module.html","searchKeys":["platformModule","val platformModule: PlatformModule","inkapplications.shade.internals.InternalsModule.platformModule"]},{"name":"val sseClient: SseClient","description":"inkapplications.shade.internals.PlatformModule.sseClient","location":"internals/inkapplications.shade.internals/-platform-module/sse-client.html","searchKeys":["sseClient","val sseClient: SseClient","inkapplications.shade.internals.PlatformModule.sseClient"]},{"name":"abstract suspend fun getButton(id: ResourceId): Button","description":"inkapplications.shade.button.ButtonControls.getButton","location":"button/inkapplications.shade.button/-button-controls/get-button.html","searchKeys":["getButton","abstract suspend fun getButton(id: ResourceId): Button","inkapplications.shade.button.ButtonControls.getButton"]},{"name":"abstract suspend fun listButtons(): List
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candle.html b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candle.html new file mode 100644 index 00000000..506abb4c --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candle.html @@ -0,0 +1,118 @@ + + + + + FootCandle + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/FootCandle
+
+

FootCandle

+
+
val FootCandle: FootCandles

Convenience reference for a single foot-candle.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/-foot-candles.html b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/-foot-candles.html new file mode 100644 index 00000000..cb29538a --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/-foot-candles.html @@ -0,0 +1,118 @@ + + + + + FootCandles + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/FootCandles/FootCandles
+
+

FootCandles

+
+
constructor(value: Number)
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/index.html b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/index.html new file mode 100644 index 00000000..a6bdc418 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/index.html @@ -0,0 +1,255 @@ + + + + + FootCandles + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/FootCandles
+
+

FootCandles

+
@JvmInline
value class FootCandles(val value: Number) : Illuminance, Dimension<FootCandles>

Us customary unit of illuminance.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(value: Number)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val symbol: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val value: Number
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Illuminance.toFootCandle(): FootCandles

Convert this illuminance to foot-candles.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toLux(): Lux
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Illuminance.toScaledLux(): ScaledLux

Convert this illuminance to Hue LogLux.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun withValue(value: Number): FootCandles
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/symbol.html b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/symbol.html new file mode 100644 index 00000000..1ba6c656 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/symbol.html @@ -0,0 +1,118 @@ + + + + + symbol + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/FootCandles/symbol
+
+

symbol

+
+
open override val symbol: String
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/to-lux.html b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/to-lux.html new file mode 100644 index 00000000..5307ac55 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/to-lux.html @@ -0,0 +1,118 @@ + + + + + toLux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/FootCandles/toLux
+
+

toLux

+
+
open override fun toLux(): Lux
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/to-string.html b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/to-string.html new file mode 100644 index 00000000..16a6e3d3 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/to-string.html @@ -0,0 +1,118 @@ + + + + + toString + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/FootCandles/toString
+
+

toString

+
+
open override fun toString(): String
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/value.html b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/value.html new file mode 100644 index 00000000..62ad7ac4 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/value.html @@ -0,0 +1,118 @@ + + + + + value + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/FootCandles/value
+
+

value

+
+
open override val value: Number
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/with-value.html b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/with-value.html new file mode 100644 index 00000000..8816d21f --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-foot-candles/with-value.html @@ -0,0 +1,118 @@ + + + + + withValue + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/FootCandles/withValue
+
+

withValue

+
+
open override fun withValue(value: Number): FootCandles
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-illuminance/index.html b/docs/reference/latest/structures/inkapplications.shade.structures/-illuminance/index.html new file mode 100644 index 00000000..b0d8ae87 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-illuminance/index.html @@ -0,0 +1,172 @@ + + + + + Illuminance + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/Illuminance
+
+

Illuminance

+
interface Illuminance

Measurement of light intensity.

Inheritors

+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Illuminance.toFootCandle(): FootCandles

Convert this illuminance to foot-candles.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract fun toLux(): Lux
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Illuminance.toScaledLux(): ScaledLux

Convert this illuminance to Hue LogLux.

+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-illuminance/to-lux.html b/docs/reference/latest/structures/inkapplications.shade.structures/-illuminance/to-lux.html new file mode 100644 index 00000000..aaf80ec8 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-illuminance/to-lux.html @@ -0,0 +1,118 @@ + + + + + toLux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/Illuminance/toLux
+
+

toLux

+
+
abstract fun toLux(): Lux
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-lux/-lux.html b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/-lux.html new file mode 100644 index 00000000..9857cc7f --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/-lux.html @@ -0,0 +1,118 @@ + + + + + Lux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/Lux/Lux
+
+

Lux

+
+
constructor(value: Number)
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-lux/index.html b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/index.html new file mode 100644 index 00000000..316f409b --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/index.html @@ -0,0 +1,255 @@ + + + + + Lux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/Lux
+
+

Lux

+
@JvmInline
value class Lux(val value: Number) : Illuminance, Dimension<Lux>

SI unit of illuminance.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(value: Number)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val symbol: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val value: Number
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Illuminance.toFootCandle(): FootCandles

Convert this illuminance to foot-candles.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toLux(): Lux
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Illuminance.toScaledLux(): ScaledLux

Convert this illuminance to Hue LogLux.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun withValue(value: Number): Lux
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-lux/symbol.html b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/symbol.html new file mode 100644 index 00000000..f4b85ba2 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/symbol.html @@ -0,0 +1,118 @@ + + + + + symbol + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/Lux/symbol
+
+

symbol

+
+
open override val symbol: String
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-lux/to-lux.html b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/to-lux.html new file mode 100644 index 00000000..cb9551da --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/to-lux.html @@ -0,0 +1,118 @@ + + + + + toLux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/Lux/toLux
+
+

toLux

+
+
open override fun toLux(): Lux
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-lux/to-string.html b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/to-string.html new file mode 100644 index 00000000..3fa9acad --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/to-string.html @@ -0,0 +1,118 @@ + + + + + toString + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/Lux/toString
+
+

toString

+
+
open override fun toString(): String
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-lux/value.html b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/value.html new file mode 100644 index 00000000..87490e61 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/value.html @@ -0,0 +1,118 @@ + + + + + value + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/Lux/value
+
+

value

+
+
open override val value: Number
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-lux/with-value.html b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/with-value.html new file mode 100644 index 00000000..454bf8f7 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-lux/with-value.html @@ -0,0 +1,118 @@ + + + + + withValue + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/Lux/withValue
+
+

withValue

+
+
open override fun withValue(value: Number): Lux
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/descriptor.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/descriptor.html new file mode 100644 index 00000000..467e8ab9 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/descriptor.html @@ -0,0 +1,118 @@ + + + + + descriptor + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLuxSerializer/descriptor
+
+

descriptor

+
+
open override val descriptor: SerialDescriptor
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/deserialize.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/deserialize.html new file mode 100644 index 00000000..c483d814 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/deserialize.html @@ -0,0 +1,118 @@ + + + + + deserialize + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLuxSerializer/deserialize
+
+

deserialize

+
+
open override fun deserialize(decoder: Decoder): ScaledLux
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/index.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/index.html new file mode 100644 index 00000000..716b1a68 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/index.html @@ -0,0 +1,176 @@ + + + + + ScaledLuxSerializer + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLuxSerializer
+
+

ScaledLuxSerializer

+
object ScaledLuxSerializer : KSerializer<Illuminance>

Serializes an illuminance value in hue's scaled logarithmic lux units.

+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val descriptor: SerialDescriptor
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun deserialize(decoder: Decoder): ScaledLux
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun serialize(encoder: Encoder, value: Illuminance)
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/serialize.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/serialize.html new file mode 100644 index 00000000..da4c2129 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux-serializer/serialize.html @@ -0,0 +1,118 @@ + + + + + serialize + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLuxSerializer/serialize
+
+

serialize

+
+
open override fun serialize(encoder: Encoder, value: Illuminance)
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/-scaled-lux.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/-scaled-lux.html new file mode 100644 index 00000000..0a6deeab --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/-scaled-lux.html @@ -0,0 +1,118 @@ + + + + + ScaledLux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLux/ScaledLux
+
+

ScaledLux

+
+
constructor(value: Number)
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/index.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/index.html new file mode 100644 index 00000000..e40e1d63 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/index.html @@ -0,0 +1,255 @@ + + + + + ScaledLux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLux
+
+

ScaledLux

+
@JvmInline
value class ScaledLux(val value: Number) : Illuminance, Dimension<ScaledLux>

Hue's custom logarithmic illuminance unit. Light level in 10000*log10(lux) + 1.

Logarithmic scale used because the human eye adjusts to light levels and small changes at low lux levels are more noticeable than at high lux levels. This allows use of linear scale configuration sliders.

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(value: Number)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val symbol: String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val value: Number
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Illuminance.toFootCandle(): FootCandles

Convert this illuminance to foot-candles.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toLux(): Lux
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Illuminance.toScaledLux(): ScaledLux

Convert this illuminance to Hue LogLux.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun toString(): String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun withValue(value: Number): ScaledLux
+
+
+
+
+
+
+
+
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/symbol.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/symbol.html new file mode 100644 index 00000000..d109d307 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/symbol.html @@ -0,0 +1,118 @@ + + + + + symbol + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLux/symbol
+
+

symbol

+
+
open override val symbol: String
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/to-lux.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/to-lux.html new file mode 100644 index 00000000..c1d485e5 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/to-lux.html @@ -0,0 +1,118 @@ + + + + + toLux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLux/toLux
+
+

toLux

+
+
open override fun toLux(): Lux
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/to-string.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/to-string.html new file mode 100644 index 00000000..32217b3e --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/to-string.html @@ -0,0 +1,118 @@ + + + + + toString + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLux/toString
+
+

toString

+
+
open override fun toString(): String
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/value.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/value.html new file mode 100644 index 00000000..55d1e125 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/value.html @@ -0,0 +1,118 @@ + + + + + value + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLux/value
+
+

value

+
+
open override val value: Number
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/with-value.html b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/with-value.html new file mode 100644 index 00000000..4464c2b4 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/-scaled-lux/with-value.html @@ -0,0 +1,118 @@ + + + + + withValue + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/ScaledLux/withValue
+
+

withValue

+
+
open override fun withValue(value: Number): ScaledLux
+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/foot-candles.html b/docs/reference/latest/structures/inkapplications.shade.structures/foot-candles.html new file mode 100644 index 00000000..422a35f4 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/foot-candles.html @@ -0,0 +1,118 @@ + + + + + footCandles + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/footCandles
+
+

footCandles

+
+
val Number.footCandles: FootCandles

Express this number as a unit in foot-candles

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/index.html b/docs/reference/latest/structures/inkapplications.shade.structures/index.html index aee0b305..7a6fce5d 100644 --- a/docs/reference/latest/structures/inkapplications.shade.structures/index.html +++ b/docs/reference/latest/structures/inkapplications.shade.structures/index.html @@ -104,7 +104,7 @@

Package-level declarations

-
+

Types

@@ -168,6 +168,21 @@

Types

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@JvmInline
value class FootCandles(val value: Number) : Illuminance, Dimension<FootCandles>

Us customary unit of illuminance.

+
+
+
+
@@ -198,6 +213,21 @@

Types

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
interface Illuminance

Measurement of light intensity.

+
+
+
+
@@ -243,6 +273,21 @@

Types

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@JvmInline
value class Lux(val value: Number) : Illuminance, Dimension<Lux>

SI unit of illuminance.

+
+
+
+
@@ -354,6 +399,36 @@

Types

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
@JvmInline
value class ScaledLux(val value: Number) : Illuminance, Dimension<ScaledLux>

Hue's custom logarithmic illuminance unit. Light level in 10000*log10(lux) + 1.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
object ScaledLuxSerializer : KSerializer<Illuminance>

Serializes an illuminance value in hue's scaled logarithmic lux units.

+
+
+
+
@@ -536,6 +611,104 @@

Types

+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val FootCandle: FootCandles

Convenience reference for a single foot-candle.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val Number.footCandles: FootCandles

Express this number as a unit in foot-candles

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val Number.lux: Lux

Express this number as an illuminance unit in Lux.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val Number.scaledLux: ScaledLux

Express this number as a Hue LogLux unit.

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Illuminance.toFootCandle(): FootCandles

Convert this illuminance to foot-candles.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Illuminance.toScaledLux(): ScaledLux

Convert this illuminance to Hue LogLux.

+
+
+
+
+
+
diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/lux.html b/docs/reference/latest/structures/inkapplications.shade.structures/lux.html new file mode 100644 index 00000000..7404eea1 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/lux.html @@ -0,0 +1,118 @@ + + + + + lux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/lux
+
+

lux

+
+
val Number.lux: Lux

Express this number as an illuminance unit in Lux.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/scaled-lux.html b/docs/reference/latest/structures/inkapplications.shade.structures/scaled-lux.html new file mode 100644 index 00000000..d4ddcc40 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/scaled-lux.html @@ -0,0 +1,118 @@ + + + + + scaledLux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/scaledLux
+
+

scaledLux

+
+
val Number.scaledLux: ScaledLux

Express this number as a Hue LogLux unit.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/to-foot-candle.html b/docs/reference/latest/structures/inkapplications.shade.structures/to-foot-candle.html new file mode 100644 index 00000000..34aa4b71 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/to-foot-candle.html @@ -0,0 +1,118 @@ + + + + + toFootCandle + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/toFootCandle
+
+

toFootCandle

+
+
fun Illuminance.toFootCandle(): FootCandles

Convert this illuminance to foot-candles.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/inkapplications.shade.structures/to-scaled-lux.html b/docs/reference/latest/structures/inkapplications.shade.structures/to-scaled-lux.html new file mode 100644 index 00000000..9fadd153 --- /dev/null +++ b/docs/reference/latest/structures/inkapplications.shade.structures/to-scaled-lux.html @@ -0,0 +1,118 @@ + + + + + toScaledLux + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
+
structures/inkapplications.shade.structures/toScaledLux
+
+

toScaledLux

+
+
fun Illuminance.toScaledLux(): ScaledLux

Convert this illuminance to Hue LogLux.

+
+
+
+ +
+
+ Generated by + + Dokka + +
© 2026 Copyright
+
+
+
+
+
+
+
+ + \ No newline at end of file diff --git a/docs/reference/latest/structures/navigation.html b/docs/reference/latest/structures/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/structures/navigation.html +++ b/docs/reference/latest/structures/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString
diff --git a/docs/reference/latest/zones/navigation.html b/docs/reference/latest/zones/navigation.html index f364f078..d71c5de6 100644 --- a/docs/reference/latest/zones/navigation.html +++ b/docs/reference/latest/zones/navigation.html @@ -374,11 +374,11 @@
-
+
internalsSkip to content
-
+
inkapplications.shade.internalsSkip to content
@@ -417,7 +417,7 @@ InternalsModule
-
+
PlatformModule
@@ -439,6 +439,56 @@
+
+
+ lightlevelSkip to content +
+
+
+ inkapplications.shade.lightlevelSkip to content +
+
+
+ LightLevelControls +
+
+
+
+ ShadeLightLevelModule +
+
+
+
+
+ inkapplications.shade.lightlevel.parametersSkip to content +
+
+
+ LightLevelUpdateParameters +
+
+
+
+
+ inkapplications.shade.lightlevel.structuresSkip to content +
+
+
+ LightLevel +
+
+
+
+ LightLevelReport +
+
+
+
+ LightLevelValue +
+
+
+
lightsSkip to content @@ -1102,152 +1152,207 @@ AuthToken
-
+
+
+ FootCandle +
+
+
+
+ FootCandles +
+
+
+
+ footCandles +
+
+
HostnameNotSetException
-
+
HueConfigurationContainer
-
+
+
+ Illuminance +
+
+
InMemoryConfigurationContainer
-
+
InternalErrorException
-
+
InvalidConfigurationException
-
+
+
+ Lux +
+
+
+
+ lux +
+
+
NetworkException
-
+
PowerInfo
-
+
PowerValue
-
+
PropertiesFileConfiguration
-
+
ResourceId
-
+
ResourceReference
-
+
- ResourceTypeSkip to content + ResourceTypeSkip to content
-
+
Companion
-
+
- SecurityStrategySkip to content + ScaledLux
-
+
+
+
+ scaledLux +
+
+
+
+ ScaledLuxSerializer +
+
+
+
+ SecurityStrategySkip to content +
+
CustomCa
-
+
HueCa
-
+
Insecure
-
+
PlatformTrust
-
+
- SegmentArchetypeSkip to content + SegmentArchetypeSkip to content
-
+
Companion
-
+
SegmentMetadata
-
+
SegmentMetadataUpdate
-
+
SerializationError
-
+
ShadeException
-
+
+
+ toFootCandle() +
+
+
+
+ toScaledLux() +
+
+
UnauthorizedException
-
+
UndocumentedApi
-
+
UnexpectedStateException
-
+
UnknownEvent
-
+
UserError
-
+
VersionString