Skip to content

Scrypted Development

Main Navigation Scrypted Docs Scripts

Appearance

Sidebar Navigation

Getting Started

Plugins

Core Reference

ScryptedDeviceBase

ScryptedDevice

EventListener

EventListenerRegister

ScryptedDeviceType

SystemManager

Device Provider Reference

DeviceManager

DeviceProvider

DeviceManifest

DeviceCreator

DeviceDiscovery

Refresh

Device

Media Reference

MediaObject

MediaManager

Webhook and Push Reference

EndpointManager

HttpRequestHandler

HttpRequest

HttpResponse

HttpResponseOptions

PushHandler

Mixin Reference

MixinDeviceOptions

MixinDeviceBase

MixinProvider

WebRTC Reference

RTCSignalingSendIceCandidate

RTCSignalingSession

RTCSignalingOptions

RTCSessionControl

RTCMediaObjectTrack

RTCOutputMediaObjectTrack

RTCInputMediaObjectTrack

RTCConnectionManagement

RTCSignalingChannel

RTCAVSignalingSetup

Device Interfaces Reference

ChatCompletionResponse

ChatCompletionResponse

Namespaces

Choice

Interfaces

Logprobs

Interfaces

Choice

ChatCompletionChunk

ChatCompletionChunk

Namespaces

Choice

Namespaces

Delta

Interfaces

Delta

Logprobs

Interfaces

Choice

ChatCompletionTool

ChatCompletionCreateParamsNonStreaming

ChatCompletionCreateParamsStreaming

sdk

TYPES_VERSION

DeviceState

DeviceBase

ScryptedInterfaceProperty

ScryptedInterfaceMethod

ScryptedInterfaceDescriptors

ScryptedNativeId

ScryptedPlugin

ScryptedRuntimeArguments

ScryptedPluginRuntime

EventListenerOptions

EventDetails

OnOff

Brightness

ColorSettingTemperature

ColorSettingRgb

ColorRgb

ColorSettingHsv

ColorHsv

Buttons

Sensor

Sensors

PressButtons

NotificationAction

NotifierOptions

Notifier

StartStop

Pause

Dock

TemperatureCommand

TemperatureSettingStatus

TemperatureSetting

HumidityMode

HumidityCommand

HumiditySettingStatus

HumiditySetting

FanMode

FanStatus

FanState

Fan

Thermometer

TemperatureUnit

HumiditySensor

ThermostatMode

PictureDimensions

PictureOptions

ResponsePictureOptions

RequestPictureOptions

Camera

H264Info

VideoStreamOptions

RequestStreamOptions

RequestVideoStreamOptions

RequestAudioStreamOptions

AudioStreamOptions

MediaStreamSource

MediaStreamTool

MediaStreamOptions

ResponseMediaStreamOptions

MediaStreamDestination

RequestMediaStreamAdaptiveOptions

RequestMediaStreamOptions

MediaStreamPacketLoss

MediaStreamFeedback

Microphone

AudioVolumes

AudioVolumeControl

VideoCamera

VideoStreamConfiguration

AudioStreamEncoding

AudioStreamConfiguration

MediaStreamConfiguration

VideoCameraConfiguration

RequestRecordingStreamOptions

DeleteRecordingStreamOptions

RecordingStreamThumbnailOptions

VideoRecorder

VideoRecorderManagement

RecordedEvent

RecordedEventOptions

EventRecorder

Resource

VideoResource

VideoClip

VideoClipOptions

VideoClipThumbnailOptions

VideoClips

Intercom

PrivacyMask

PrivacyMasks

VideoCameraMask

VideoTextOverlay

VideoTextOverlays

PanTiltZoomMovement

PanTiltZoomCommand

LLMTools

ChatCompletion

PanTiltZoomCapabilities

PanTiltZoom

Display

Lock

LockState

PasswordStore

Scene

Entry

EntrySensor

DeviceCreatorSettings

DiscoveredDevice

AdoptDevice

Battery

ChargeState

Charger

Sleep

Reboot

MediaPlayer

MediaPlayerOptions

Online

Program

ScriptSource

Scriptable

BufferConverter

MediaConverterTypes

MediaConverter

Settings

ScryptedSystemDevice

ScryptedSystemDeviceInfo

ScryptedSettings

ScryptedDeviceCreator

BinarySensor

TamperState

TamperSensor

PowerSensor

AudioSensor

MotionSensor

AmbientLightSensor

OccupancySensor

FloodSensor

UltravioletSensor

LuminanceSensor

Position

PositionSensor

AirPurifierStatus

AirPurifierMode

AirPurifierState

AirPurifier

FilterMaintenance

PM10Sensor

PM25Sensor

VOCSensor

NOXSensor

CO2Sensor

AirQuality

AirQualitySensor

SecuritySystemMode

SecuritySystemObstruction

SecuritySystemState

SecuritySystem

ObjectDetectionHistory

BoundingBoxResult

ObjectDetectionResult

ObjectsDetected

ObjectDetectionClass

ObjectDetectionTypes

ObjectTracker

ObjectDetector

ObjectDetectionGeneratorSession

ObjectDetectionSession

ObjectDetectionModel

ObjectDetectionGeneratorResult

ObjectDetectionZone

ObjectDetection

ObjectDetectionPreview

ObjectDetectionGenerator

ImageFormat

ImageOptions

Image

VideoFrame

VideoFrameGeneratorOptions

VideoFrameGenerator

StreamService

TTY

TTYSettings

Logger

Readme

OauthClient

SerializableType

TopLevelSerializableType

MediaObjectOptions

MediaObjectCreateOptions

MediaContainer

MediaStreamUrl

FFmpegInput

DeviceInformation

EndpointAccessControlAllowOrigin

EngineIOHandler

SystemDeviceState

MediaStatus

MediaPlayerState

SettingValue

Point

ClipPath

Setting

LauncherApplicationInfo

LauncherApplication

ScryptedInterface

RTCSignalingClient

KvmKeyEvent

KvmMouseEvent

ScryptedMimeTypes

RequestMediaObject

RequestMediaStream

FFmpegTranscode

FFmpegTranscodeStream

ClusterForkInterfaceOptions

ClusterForkInterface

ForkWorker

PluginFork

WritableDeviceState

ScryptedInterfaceDescriptor

ScryptedDeviceAccessControl

ScryptedUserAccessControl

ScryptedUser

APIOptions

ConnectOptions

ForkOptions

ClusterFork

ClusterWorker

ClusterManager

ScryptedStatic

On this page

Scrypted Documentation / BinarySensor

Interface: BinarySensor

Properties

binaryState?

optional binaryState: boolean

Pager

Previous pageScryptedDeviceCreator

Next pageTamperState