4. Space types

This section provides the specifications related to all supported space types that comply to the communication models

4.1. Definitions

Common definitions

Common definitions

4.1.1. Spaces Definitions

Site

A geographic area that defines the boundaries where a common activity takes place. It is generally represented by one or multiple buildings.

The university campus is a very large site that spreads on both banks of the river

Building

A permanent enclosed construction with walls and a roof where a community of people perform an activity.

This building is the world headquarter of this large global company

Floor

The area on the same level of a Building.

The administration department is on the third floor of the building

Room

A part of division of a floor enclosed by walls and accessible through at least one door.

His office is in the third room on the left

Suite

A set of rooms or floors designated for a particular activity.

The company is in suite 401 which occupies the entire fourth floor and part of the fifth floor of the building

Restroom

A room or suite in a public building having a combination of sinks, toilets, and other hygiene capabilities.

You will find the restroom at the end of the hallway

Toilet

An area of a restroom with some privacy for getting rid of bodily waste.

The restroom has 2 toilets

Hallway

A passage with doors on the sides to access rooms.

When you exit the elevator, go to the left and your room will be at the end of the hallway

Corridor

A passage connecting parts of a building.

There is an underground corridor that connects building A to building B

Aisle

A walkway between two sections in a room.

Bread can be found in aisle 7 of the supermarket

Cubicle

A area of a room partitioned-off with low walls with open access.

The large room contained 500 identical cubicles

Section

A distinct area that delimits a larger space without physical boundaries.

The surveillance camera covers the left section of the room

4.1.2. Web API (Pull Model)

• The digital twin information provider must expose the spaces endpoint to get the the list of available spaces and their specifications

GET https://{Digital Twin Information Provider URL}/fds/v2/spaces

• The device information provider must expose the statuses endpoint to get the latest status for one or multiple devices

GET https://{Device Information Provider URL}/fds/v2/statuses

• The device information provider must expose the diagnostics endpoint to get the diagnostic for one or multiple devices

GET https://{Device Information Provider URL}/fds/v2/diagnostics

Note

The statistics endpoint to expose the statistics information is not being defined for dispensers in FDS Version 2

A call to:

GET https://{Device Information Provider URL}/fds/v2/statistics

must return an error object

{
    "status": 204,
    "message": "not_implemented"
}

• The device information provider must expose the POST request on the tag endpoint to let a client application create a new tag

POST https://{Entity Information Provider URL}/fds/v2/tag

• The device information provider must expose the GET request on the tag endpoint to provide the content of a tag

GET https://{Entity Information Provider URL}/fds/v2/tag

• The device information provider must expose the DELETE request on the tag endpoint

DELETE https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>

• The device information provider must expose the PUT request on the tag/<tag_id>/entities endpoint

PUT https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>/entities

• The device information provider must expose the DELETE request on the tag/<tag_id>/entities endpoint

DELETE https://{Entity Information Provider URL}/fds/v2/tag/<tag_id>/entities

4.1.3. Publish/Subscribe (Push model)

4.1.3.1. Events

• The device information provider must publish the following alerts and notifications

Message code	Description	Message category	Message code specific object
out_of_order	The device is out of order and needs service intervention	alert	out_of_order_details property - array of information provider codes
offline	The device is not communicating	notification	last_contact property

4.1.3.2. Publish status information

The following data must be published by the information provider

fds/v2/<subscriber_id>/<tag_id>/bin/<device_id>/status/filling_level

• The payload must be:

  • The filling_level object

4.1.3.3. Publish predictive and prognostic information

The following data must be published by the information provider

fds/v2/<subscriber_id>/<tag_id>/bin/<device_id>/diagnostics/expected_next_service

• The payload must be:

  • The expected_next_service property

• 4.1.3.3.1. Building
  • 4.1.3.3.1.1. FDS compliance requirements
    • 4.1.3.3.1.1.1. Object Model
      • 4.1.3.3.1.1.1.1. Space object for the building space type
    • 4.1.3.3.1.1.2. Web API (Pull Model)
    • 4.1.3.3.1.1.3. Publish/Subscribe (Push model)
  • 4.1.3.3.1.2. Use case example
    • 4.1.3.3.1.2.1. Building space type
• 4.1.3.3.2. Floor
  • 4.1.3.3.2.1. FDS compliance requirements
    • 4.1.3.3.2.1.1. Object Model
      • 4.1.3.3.2.1.1.1. Space object for the building space type
    • 4.1.3.3.2.1.2. Web API (Pull Model)
    • 4.1.3.3.2.1.3. Publish/Subscribe (Push model)
  • 4.1.3.3.2.2. Use case example
    • 4.1.3.3.2.2.1. Floor space type
• 4.1.3.3.3. Other logical space types
  • 4.1.3.3.3.1. FDS compliance requirements
    • 4.1.3.3.3.1.1. Object Model
      • 4.1.3.3.3.1.1.1. Space object for the these space types
    • 4.1.3.3.3.1.2. Web API (Pull Model)
    • 4.1.3.3.3.1.3. Publish/Subscribe (Push model)
  • 4.1.3.3.3.2. Use case example
    • 4.1.3.3.3.2.1. Other logical space types
• 4.1.3.3.4. Other physical space types
  • 4.1.3.3.4.1. FDS compliance requirements
    • 4.1.3.3.4.1.1. Object Model
      • 4.1.3.3.4.1.1.1. Space object for the these space types
    • 4.1.3.3.4.1.2. Web API (Pull Model)
    • 4.1.3.3.4.1.3. Publish/Subscribe (Push model)
  • 4.1.3.3.4.2. Use case example
    • 4.1.3.3.4.2.1. Other physical space types
• 4.1.3.3.5. Site
  • 4.1.3.3.5.1. FDS compliance requirements
    • 4.1.3.3.5.1.1. Object Model
      • 4.1.3.3.5.1.1.1. Space object for the site space type
    • 4.1.3.3.5.1.2. Web API (Pull Model)
    • 4.1.3.3.5.1.3. Publish/Subscribe (Push model)
  • 4.1.3.3.5.2. Use case example
    • 4.1.3.3.5.2.1. Site space type