During the initialization phase, the BOS will generate the collections and the documents inside each collection. Each document is basically a JSON file containing all the information about an asset.
Device, Equipment, Model and LinksperInstance assets
For Device asset, Equipment asset, Model asset and LinksperInstance asset, one document will be created per published asset. Note that, not all the assets will be published. A MSI will choose which asset should be published to a third party. For example, only the Structure Data Model is published among the Model asset because, they are the only ones implemented specifically for the site.
A document in this "assets" collection will contain:
- An id field to uniquely identify the document. These id will come from the BOS and match internal asset id in the BOS: Device asset, Equipment asset, Model asset...
- A deviceId which equal to the id field.
- A tags object, containing all the information about the asset. We will use it intensively to query assets.
Example of an asset document (a light in this case)
To learn about the available tags, you need to check each type of assets: Device asset, Equipment asset, Model asset
Point Data assets
During the initialization phase, one document per published Point Data asset will be created in the "points" collection. Each document will contain static and dynamic information:
- An id field to uniquely identify the document. These id match the respective Data asset id in the BOS.
- A deviceId field to associate the Data asset to a container such as a Device asset, Equipment asset, Model asset. The deviceId value will always match one of these assets. (There is no link at all with the concept of "device")
- A tags object, containing all the information about the Data asset. We will use it intensively as well.
- A status field indicating the live Linksper statuses from the BOS. You can subscribe to it to receive real-time changes.
- A value field indicating the live value from the BOS. You can subscribe to it to receive real-time changes.
- A timestamp field indicating the latest update
Example of a Point Data asset:
To learn about the available tags, you need to check each type of assets: Data asset and Point data type.
Schedule Data assets
During the initialization phase, one document per published Schedule Data asset will be created in the "points" collection. Each document will contain static and dynamic information:
- An id field to uniquely identify the document. These id match the respective Data asset id in the BOS.
- A deviceId field to associate the Data asset to a container such as a Device asset, Equipment asset, Model asset. The deviceId value will always match one of these assets. (There is no link at all with the concept of "device")
- A tags object, containing all the information about the Data asset. We will use it intensively as well.
- A statusValue field indicating the live Linksper statuses from the BOS. You can subscribe to it to receive real-time changes.
- A dataValue field indicating the live value from the BOS. You can subscribe to it to receive real-time changes.
- A timestamp field indicating the latest update
- A nextDataValue and nextTime to anticipate the next change of value
- A recurringEvents array to retrieve all regular events per weekday. See Schedule data type for more information
- A singleEvents array to retrieve special events such as bookings. See Schedule data type for more information.
Example of a Schedule Data asset document:
Alarm and Reference Data assets
Unlike the other assets, these two assets are event related. It means that their respective documents will be generated on the fly when an event occurs.