Configuring a site

Configuring the site involves defining the stages, onboarding areas, etc., at the location. The distribution includes a file to configure a test site.

• sampleSiteDefinition.YAML creates a site definition for your testing space.

Inside the YAML configuration file, you can easily configure your specific site from scratch by adapting the files.

Details on the configuration files

Here is a Yaml file that contains configurations to set up the site.

Example site configuration yaml

# Operations Areas

operations_areas:

  - name: "OnboardArea_1"
    description: "Sample onboard area 1"
    queue_capacity: 30

  - name: "OnboardArea_2"
    description: "Sample onboard area 2"
    queue_capacity: 25

# Trackable Spaces

trackable_spaces:

  - name: "MyLocationTrackableSpace"
    description: "Generic Test Space Marcel Home"

# Stages

stages:

  - name: "Stage1"
    trackable_space: "MyLocationTrackableSpace"

devices:

  # Devices assigned to onboard area 1

  - scan_id: "Dev1"
    machine_id_list:
      - "2bac638c2d4fa14c"
    onboard_area: "OnboardArea_1"


 # Devices assigned to onboard area 2

  - scan_id: "Dev2"
    machine_id_list:
      - "89df5d7sdf89d756"
    onboard_area: "OnboardArea_2"

You can see that the file configures the operations_area, trackable_spaces, stages, and devices.

Operations Area

• First, we configure the operations_areas by specifying the name, a description of the area, and the queue capacity. The queue capacity is the number of people allowed to wait to be onboarded. By default, we have it set to 25, but it can be changed based on how big the onboard area is. These are abstract areas used for onboarding and offboarding. Their location is not important right now, but if you have multiple shows at a location, it is important for the system to know if and how operations areas are being shared so that it can track headsets and prevent mistakes.

# Operations Areas

operations_areas:

  - name: "OnboardArea_1"
    description: "Sample onboard area 1"
    queue_capacity: 30

  - name: "OnboardArea_2"
    description: "Sample onboard area 2"
    queue_capacity: 25

Trackable space & Stages

• Next, we define the trackable space and stages. This corresponds to an area with markers where shows are held. Like with the operations area, it is currently not important to understand the details of the trackable space, but if there are multiple shows at the site, it is important for GEM to understand if the trackable space is being shared between simultaneous shows.

# Trackable Spaces

trackable_spaces:

  - name: "MyLocationTrackableSpace"
    description: "Generic Test Space Marcel Home"

# Stages

stages:

  - name: "Stage1"
    trackable_space: "MyLocationTrackableSpace"

  - name: "Stage2"
    trackable_space: "MyLocationTrackableSpace"

Devices

We add devices (headsets) that customers will use. Before being used, devices must be assigned to an onboard area. The scan_id is a QR code attached to the devices. In this example, the scan_id is a unique ID that we use to identify each device on hand.

 # Devices assigned to onboard area 1

  - scan_id: "Dev2"
    machine_id_list:
      - "89df5d7sdf89d756"
    onboard_area: "OnboardArea_2"