Grizzly.ZWave.Commands.CredentialLearnStatusReport (grizzly v8.15.3)

CredentialLearnStatusReport is used to report the status of the learning process for a credential.

Parameters

:status - the status of the learning process (required)
- :started - learning has started
- :success - learning was successful
- :already_in_progress - learning is already in progress
- :ended_not_due_to_timeout - learning ended but not due to timeout
- :timeout - learning timed out
- :learn_step_retry - retrying a learn step
- :invalid_add_operation - invalid add operation
- :invalid_modify_operation - invalid modify operation
:user_id - the ID of the user for the credential (required)
:credential_type - the type of credential (required)
:credential_slot - the slot of the credential (required)
:steps_remaining - the number of learn steps remaining (required)

Summary

Types

learn_status()

param()

Types

learn_status()

@type learn_status() ::
  :started
  | :success
  | :already_in_progress
  | :ended_not_due_to_timeout
  | :timeout
  | :learn_step_retry
  | :invalid_add_operation
  | :invalid_modify_operation

param()

@type param() ::
  {:status, learn_status()}
  | {:user_id, 1..65535}
  | {:credential_type,
     Grizzly.ZWave.CommandClasses.UserCredential.credential_type()}
  | {:credential_slot, 1..65535}
  | {:steps_remaining, byte()}