deckster/README.md

1 KiB
Raw Blame History

Deckster

Contributing

Terminology

  • handler runner: Node that is running handlers.
  • handler host: A handler runner that is not the coordinator.
  • coordinator: Node to which the Loupedeck device is physically connected. Always a handler runner.

The different types of unwrap

  • expect("<reason>"): The author thinks that unwrapping will never fail because of <reason>.
  • unwrap(): The author assumes that unwrapping will never fail but explaining why is either obvious or too complicated.
  • unwrap_todo(): The author has not yet thought about how to handle this value being None or Err. They will replace this unwrapping with expect("<reason>"), unwrap(), or proper error handling later.

Attribution

foxxyzs loupedeck library for JavaScript (licensed under the MIT license) was used as a reference for and inspired the design of loupedeck_serial.