Skip to content

Configuration Structure

Raman Gupta edited this page Mar 7, 2024 · 3 revisions

If you decide to use the UI option when configuring Lock Code Manager, the UI will step you through the configuration. If you decide to use the YAML approach, refer to the following format:

1:  # slot number is the top level key
  name: fake_name  # this is optional but assigns a friendly name to the slot which will be used in the events
  pin: "1234"  # this is optional if the slot is disabled using the enabled switch, but if you attempt to enable it, you will need to set this first. Be sure to use quotes!
  enabled: true  # this is optional and defaults to true, set to false to disable the PIN
  calendar: calendar.my_local_calendar  # this is optional. If excluded, the integration will not use a calendar to manage this slot. If provided, it needs to be a valid calendar entity ID.
  number_of_uses: 15  # this is optional. If excluded, the integration will not track the number of uses for a slot. If provided, it needs to be a positive number > 0.
2:  # bare minimum config for a slot
  enabled: false
3:  # This will cause an error because you need to have a PIN defined if the slot is enabled.
  enabled: true
4: null  # The equivalent of slot 3