Skip to content

Configuring welcome signs

The welcome sign serves as a versatile dashboard to help visitors quickly find what they're looking for. They're configured in the optional welcome_signs section of awesign.yaml.

A sample configuration looks like this:

welcome_signs:
  - name: welcome_demo
    header: "This is a demo welcome sign!"
    header_font_size: 2.5
    right_header: "What are you looking for?"
    department: test_department
    building: test_building
    floor: 1
    show_status_bar: true
    status_bar_settings:
      show_logo: true
      show_weather: true
      show_clock: true
      show_clock_seconds: false
    buttons:
      - label: "Faculty/Staff Directory"
        action: switch_tab
        sub_label: "Switch to the department directory tab"
        tab_display_name: "Department directory"
      - label: "Rooms"
        action: label
        sub_label: "Tap a room for directions"
      - label: "Main Office"
        sub_label: "Tap for directions"
        action: set_map_destination
        map_destination_room_number: "main_office"
      - label: "Building 123"
        action: set_map_destination
        map_destination_room_number: "123"
        reservations_room_number: "123"

Configuration explanation

  • name is a unique identifier for this welcome sign; it will be used in URLs and dynamic sign parameters.
  • header is an optional string to display above the floor map.
  • header_font_size is an optional float/int to scale the font size for your header text. The default value is 3.0.
  • right_header is an optional string to display above the buttons on the right-hand side of the sign. It will stick to the top instead of scrolling with the buttons. Its font size cannot be adjusted, as its style will match the labels inside the buttons list.
  • department is the name of a department from the departments configuration section. It will be used for map details and the header logo.
  • building is the name of a building from the buildings configuration section. It will be used for the map.
  • floor is an integer to identify the floor number within the specified building's configuration. It will be used for the map.
  • show_status_bar is an optional boolean that enables the status bar at the top of the sign when true. Defaults to true.
  • status_bar_settings allows you to configure which elements will display on the status bar if show_status_bar is true.
    • show_logo: Displays the department's logo if true. Optional; defaults to true.
    • show_weather: Displays the current weather if true. Optional; defaults to true.
    • show_clock: Displays the current date and time if true. Optional; defaults to true.
    • show_clock_seconds: Displays the seconds bar on the clock if true. Optional; defaults to true.
  • buttons is a highly-configurable list of actions and labels to display on the right side of the sign. They can interact with the map and tab navigation (if nested within a tab group). Buttons will be rendered in the order defined here.
    • label is the header text for the button or label.
    • action defines what this button or label will do. Additional fields may be required depending on the selected action. All actions are detailed below with which additional parameters are available/required.

Button actions

This section details which values are available for the action field in the button config and their additional parameters.

label

The label action displays non-interactive text in the scrollable buttons list. It can be used to separate categories of buttons or provide additional context.

  • sub_label is an optional string to display in smaller text below the label text.

switch_tab

The switch_tab action navigates to another tab if the welcome sign is within a tab group.

  • tab_display_name is the required display_name of the tab as configured in the tab group.
  • sub_label is an optional string to display in smaller text below the label text.

set_map_destination

The set_map_destination action places a pin on the map pointing to the specified destination and draws a path if possible. It can optionally integrate with room reservations to display the current and next event in the room.

  • map_destination_room_number is a string (so put it in quotes if it's numerical) matching the name of the room from the rooms configuration (or the "name" of the point on the floor map) to indicate the destination.
  • reservations_room_number is an optional string with the same conditions as map_destination_room_number. If specified, the button will display the current and next events taking place in the specified room based on EMS room reservations or ical room reservations.