LockProperties.md

seamapi / Exports / LockProperties

Interface: LockProperties

Hierarchy

• CommonDeviceProperties

  ↳ LockProperties

Table of contents

Properties

• august_metadata
• battery
• battery_level
• code_constraints
• door_open
• has_direct_power
• image_alt_text
• image_url
• keypad_battery
• locked
• manufacturer
• max_active_codes_supported
• model
• name
• nuki_metadata
• online
• schlage_metadata
• serial_number
• smartthings_metadata
• supported_code_lengths
• ttlock_metadata

Properties

august_metadata

• Optional august_metadata: Object

Type declaration

Name	Type
has_keypad	boolean
house_id?	string
house_name	string
keypad_battery_level?	string
lock_id	string
lock_name	string
model?	string

Defined in

src/types/models.ts:330

---

battery

• Optional battery: Object

Type declaration

Name	Type
level	number
status	BatteryStatus

Inherited from

CommonDeviceProperties.battery

Defined in

src/types/models.ts:230

---

battery_level

• Optional battery_level: number

Defined in

src/types/models.ts:312

---

code_constraints

• Optional code_constraints: AccessCodeConstraint[]

Defined in

src/types/models.ts:319

---

door_open

• Optional door_open: boolean

Defined in

src/types/models.ts:311

---

has_direct_power

• Optional has_direct_power: boolean

Defined in

src/types/models.ts:316

---

image_alt_text

• Optional image_alt_text: string

Inherited from

CommonDeviceProperties.image_alt_text

Defined in

src/types/models.ts:235

---

image_url

• Optional image_url: string

Inherited from

CommonDeviceProperties.image_url

Defined in

src/types/models.ts:234

---

keypad_battery

• Optional keypad_battery: Object

Type declaration

Name	Type
level	number

Defined in

src/types/models.ts:313

---

locked

• locked: boolean

Defined in

src/types/models.ts:310

---

manufacturer

• Optional manufacturer: string

Inherited from

CommonDeviceProperties.manufacturer

Defined in

src/types/models.ts:224

---

max_active_codes_supported

• Optional max_active_codes_supported: number

Defined in

src/types/models.ts:318

---

model

• model: Object

Type declaration

Name	Type
display_name	string
manufacturer_display_name	string

Inherited from

CommonDeviceProperties.model

Defined in

src/types/models.ts:225

---

name

• name: string

Inherited from

CommonDeviceProperties.name

Defined in

src/types/models.ts:223

---

nuki_metadata

• Optional nuki_metadata: Object

Type declaration

Name	Type
keypad_battery_critical?	boolean

Defined in

src/types/models.ts:340

---

online

• online: boolean

Inherited from

CommonDeviceProperties.online

Defined in

src/types/models.ts:229

---

schlage_metadata

• Optional schlage_metadata: Object

Type declaration

Name	Type
access_code_length	number
device_id	string
device_name	string
location_id?	string
model?	string

Defined in

src/types/models.ts:322

---

serial_number

• Optional serial_number: string

Defined in

src/types/models.ts:320

---

smartthings_metadata

• Optional smartthings_metadata: unknown

Defined in

src/types/models.ts:344

---

supported_code_lengths

• Optional supported_code_lengths: number[]

Defined in

src/types/models.ts:317

---

ttlock_metadata

• Optional ttlock_metadata: Object

Type declaration

Name	Type
lock_alias	string
lock_id	number

Defined in

src/types/models.ts:346