hassle/com.codellyrandom.hassle/HomeAssistantApiClient

HomeAssistantApiClient

The client object for interacting with the Home Assistant WebSocket API.

Functions

abstract fun <ED> attachEventHandler(eventType: EventType, eventDataType: KClass<*>, eventHandler: EventHandlerFunction<ED>): Switchable

Attaches an EventHandlerFunction to the API client and starts the Home Assistant event subscription.

connect

abstract fun connect()

emitEvent

abstract suspend fun emitEvent(eventType: String, eventData: Any? = null)

Emits a Home Assistant event with optional event data.

setErrorResponseHandler

abstract fun setErrorResponseHandler(errorResponseHandler: (ErrorResponseData) -> Unit)

Attaches an error response handler to the API client.

setEventHandlerExceptionHandler

abstract fun setEventHandlerExceptionHandler(f: (Throwable) -> Unit)

Overwrites the default event handler exception handler action.

Properties

connectionExceptionHandler

abstract var connectionExceptionHandler: (Throwable) -> Unit

The action that gets executed when an exception occurs while connecting to Home Assistant.

observerExceptionHandler

abstract var observerExceptionHandler: (Throwable) -> Unit

The action that gets executed when the observer action executes with an exception.

Extensions

attachEventHandler

inline fun <ED> HomeAssistantApiClient.attachEventHandler(eventType: EventType, noinline eventHandler: EventHandlerFunction<ED>): Switchable

attachIosActionHandler

fun HomeAssistantApiClient.attachIosActionHandler(eventHandler: EventHandlerFunction<IosActionEventData>): Switchable

attachIosNotificationActionHandler

fun <AD> HomeAssistantApiClient.attachIosNotificationActionHandler(eventHandler: EventHandlerFunction<IosNotificationActionEventData<AD>>): Switchable

ContactSensor

fun HomeAssistantApiClient.ContactSensor(objectId: ObjectId): ContactSensor

createPersistentNotification

suspend fun HomeAssistantApiClient.createPersistentNotification(message: String, title: String? = null, notificationId: String? = null): Int

DayTime

fun HomeAssistantApiClient.DayTime(objectId: ObjectId): DayTime

DimmableLight

fun HomeAssistantApiClient.DimmableLight(objectId: ObjectId): DimmableLight

dismissPersistentNotification

suspend fun HomeAssistantApiClient.dismissPersistentNotification(id: String): Int

InputBoolean

fun HomeAssistantApiClient.InputBoolean(objectId: ObjectId): InputBoolean

InputDate

fun HomeAssistantApiClient.InputDate(objectId: ObjectId): InputDate

InputDateTime

fun HomeAssistantApiClient.InputDateTime(objectId: ObjectId): InputDateTime

InputNumber

fun HomeAssistantApiClient.InputNumber(objectId: ObjectId): InputNumber

InputSelect

fun HomeAssistantApiClient.InputSelect(objectId: ObjectId): InputSelect

InputText

fun HomeAssistantApiClient.InputText(objectId: ObjectId): InputText

InputTime

fun HomeAssistantApiClient.InputTime(objectId: ObjectId): InputTime

LuminanceSensor

fun HomeAssistantApiClient.LuminanceSensor(objectId: ObjectId): LuminanceSensor

markPersistentNotificationAsRead

suspend fun HomeAssistantApiClient.markPersistentNotificationAsRead(id: String): Int

MediaReceiver

fun HomeAssistantApiClient.MediaReceiver(objectId: ObjectId): MediaReceiver

fun HomeAssistantApiClient.MediaReceiver(entityId: EntityId): MediaReceiver

MotionSensor

fun HomeAssistantApiClient.MotionSensor(objectId: ObjectId): MotionSensor

notifyMobileApp

suspend fun HomeAssistantApiClient.notifyMobileApp(device: Device, message: String, title: String? = null): Int

suspend fun HomeAssistantApiClient.notifyMobileApp(device: Device, messageBuilder: MobileNotificationData.() -> Unit): Int

suspend fun HomeAssistantApiClient.notifyMobileApp(vararg devices: Device, title: String, message: String)

Person

fun HomeAssistantApiClient.Person(objectId: ObjectId): Person

PositionableCover

fun HomeAssistantApiClient.PositionableCover(objectId: ObjectId): PositionableCover

PowerMeasuringSwitch

fun HomeAssistantApiClient.PowerMeasuringSwitch(objectId: ObjectId): PowerSwitch

requestLocationUpdate

suspend fun HomeAssistantApiClient.requestLocationUpdate(device: Device): Int

suspend fun HomeAssistantApiClient.requestLocationUpdate(vararg devices: Device)

RGBLight

fun HomeAssistantApiClient.RGBLight(objectId: ObjectId): RGBLight

RGBWLight

fun HomeAssistantApiClient.RGBWLight(objectId: ObjectId): RGBWLight

Sun

fun HomeAssistantApiClient.Sun(): Sun

SwitchableLight

fun HomeAssistantApiClient.SwitchableLight(objectId: ObjectId): SwitchableLight

Television

fun HomeAssistantApiClient.Television(objectId: ObjectId): Television

Thermostat

fun HomeAssistantApiClient.Thermostat(objectId: ObjectId): Thermostat