Search documentation of grizzly

# View Source Grizzly.ZWave.Commands.DoorLockOperationReport (grizzly v7.4.2)

OperationReport is used to advertise the status of a door lock

This is response to the `Grizzly.ZWave.Commands.OperationGet` command.

Params:

- `:mode` - the door operating lock mode (required)
- `:outside_handles_mode` - a map of the outside door handles and if they can or cannot open the door locally (optional)
- `:inside_handles_mode` - a map of the inside door handles and if they can or cannot open the door locally (optional)
- `:latch_position` - the position of the latch (optional)
- `:bolt_position` - the position of the bolt (optional)
- `:door_state` - the state of the door being open or closed (optional)
- `:timeout_minutes` - how long the door has been unlocked (required)
- `:timeout_seconds` - how long the door has been unlocked (required)
- `:target_mode` - the target mode of an ongoing transition or of the most recent transition (optional - v4)
- `duration` - the estimated remaining time before the target mode is realized (optional - v4)

# Summary

## Types

bolt_position()

This param only matters if the door lock says it supports this door component in the CapabilitiesReport.

door_state()

This param only matters if the door lock says it supports this door component in the CapabilitiesReport.

handles_mode()

These modes tell if the handle can open the door locally or not.

latch_position()

This param only matters if the door lock says it supports this door component in the CapabilitiesReport.

param()
timeout_minutes()
timeout_seconds()

## Functions

door_condition_to_byte(latch_position, bolt_position, door_state)
door_handles_modes_to_byte(handles_mode)

# Types

Link to this type

# bolt_position()

View Source

    @type bolt_position() :: :locked | :unlocked

This param only matters if the door lock says it supports this door component in the CapabilitiesReport.

If it isn't support the node receiving this report can ignore.

For defaults, if this param isn't provided during when calling `new/1`, we 0 this field out by setting it to :disabled

Link to this type

# door_state()

View Source

    @type door_state() :: :open | :closed

This param only matters if the door lock says it supports this door component in the CapabilitiesReport.

If it isn't support the node receiving this report can ignore.

For defaults, if this param isn't provided during when calling `new/1`, we 0 this field out by setting it to :disabled

Link to this type

# handles_mode()

View Source

    @type handles_mode() :: %{required(non_neg_integer()) => :enabled | :disabled}

These modes tell if the handle can open the door locally or not.

The door lock does not have to report all or any of these, so the default is to set them all to disabled if they are not specified when building the command.

Link to this type

# latch_position()

View Source

    @type latch_position() :: :open | :closed

This param only matters if the door lock says it supports this door component in the CapabilitiesReport.

If it isn't support the node receiving this report can ignore.

For defaults, if this param isn't provided during when calling `new/1`, we 0 this field out by setting it to :disabled

Link to this type

# param()

View Source

    @type param() ::
      {:mode, Grizzly.ZWave.CommandClasses.DoorLock.mode()}
      | {:outside_handles_mode, handles_mode()}
      | {:inside_handles_mode, handles_mode()}
      | {:latch_position, latch_position()}
      | {:bolt_position, bolt_position()}
      | {:door_state, door_state()}
      | {:timeout_minutes, timeout_minutes()}
      | {:timeout_seconds, timeout_seconds()}
      | {:target_mode, Grizzly.ZWave.CommandClasses.DoorLock.mode()}
      | {:duration, :unknown | non_neg_integer()}

Link to this type

# timeout_minutes()

View Source

    @type timeout_minutes() :: 0..253 | :undefined

Link to this type

# timeout_seconds()

View Source

    @type timeout_seconds() :: 0..59 | :undefined

# Functions

Link to this function

# door_condition_to_byte(latch_position, bolt_position, door_state)

View Source
Link to this function

# door_handles_modes_to_byte(handles_mode)

View Source