Nfrax Docs logoNfrax Docs

Infrastructure that just works. Ship products, not boilerplate.

Frameworks

  • svc-infra
  • ai-infra
  • fin-infra
  • robo-infra

Resources

  • Getting Started
  • What's New
  • Contributing

Community

  • GitHub

© 2026 nfrax. All rights reserved.

Nfrax Docs logoNfrax Docs
Start HereWhat's New
GitHub
robo-infra / API Reference

Lock

from robo_infra.controllers import Lock
View source
robo_infra.controllers
Extends:Controller

Controller for robotic locks and latches. Lock provides high-level control for locking mechanisms, with state tracking and optional security features. Features: - Lock/unlock control - State tracking (locked/unlocked/transitioning) - Async support for transition timing - Optional auto-lock timeout - Toggle convenience method

Example

>>> lock = Lock("door", servo, config=LockConfig(name="door")) >>> lock.enable() >>> lock.unlock() >>> assert lock.is_unlocked >>> lock.lock() >>> assert lock.is_locked

Constructor
Lock(name: str, actuator: Actuator, config: LockConfig | None = None) -> None
ParameterTypeDefaultDescription
namerequiredstr—Controller name
actuatorrequiredActuator—Lock actuator (servo, motor, solenoid, etc.)
configLockConfig |NoneNoneOptional configuration

Methods

On This Page

Constructoralockaunlockdisableenablelockstoptoggleunlock