DoorLocks
DoorLocks
→ GetLockState
Declaration
hmkit.autoapi.commands.getlockstate.GetLockState()
Discussion
Command to request the lock state of the car. The car will respond with a Lock State command.
Command sent from the car every time the lock state changes or when a Get Lock State is received. The new status is included in the command payload and may be the result of user, device or car triggered action.
getoutside_locks
Declaration
hmkit.autoapi.commands.lockstate.LockState.getoutside_locks()
Returns
List of properties.doorlockstate.DoorLockSate
Discussion
Get method. Get the outside door lock states.
getinside_locks
Declaration
hmkit.autoapi.commands.lockstate.LockState.getinside_locks()
Returns
List of properties.doorlockstate.DoorLockSate
Discussion
Get method. Get the inside door lock states.
getpositions
Declaration
hmkit.autoapi.commands.lockstate.LockState.getpositions()
Returns
List of properties.doorposition.DoorPosition
Discussion
Get method. Get the outside door lock states.
getoutside_lock
Declaration
python hmkit.autoapi.commands.lockstate.LockState.getoutside_lock(doorlocation)
Parameters
| doorlocation | hmkit.autoapi.properties.value.location.Location |
Returns
properties.doorlockstate.DoorLockSate
Discussion
Get method. Get the outside lock state for a specific door.
getinside_lock
Declaration
python hmkit.autoapi.commands.lockstate.LockState.getinside_lock(doorlocation)
Parameters
| doorlocation | hmkit.autoapi.properties.value.location.Location |
Returns
List of properties.doorlockstate.DoorLockSate
Discussion
Get method. Get the inside lock state for a specific door.
getposition
Declaration
hmkit.autoapi.commands.lockstate.LockState.getposition(doorlocation)
Parameters
| doorlocation | hmkit.autoapi.properties.value.location.Location |
Returns
properties.doorposition.DoorPosition
Discussion
Get method. Get the outside lock state for a specific door.
islocked
Declaration
hmkit.autoapi.commands.lockstate.LockState.islocked()
Returns
True/False
Discussion
Get method. Whether all of the outside door locks are locked.
→ LockUnlockDoors
Declaration
hmkit.autoapi.commands.lockunlockdoors.LockUnlockDoors(lock.Lock)
Parameters
| lock.Lock | enum class hmkit.autoapi.properties.value.lock.Lock |
Discussion
Command to lock or unlock all doors of the car. The car will respond with the updated lock state in a Lock State message.