External Model Namespace - Revamped

| Introduction

The revamped External Model namespace combines the Modbus and External Models in a common namespace. This helps in avoiding any confusion but also saves time in creating and updating the model irrespective of changes in communication protocol.

The advantages of a Common External Model namespace are:

• Users will be able to add/edit a Base Model.
• Users will be able to add/edit a Modbus Model.
• Users will be able to add/edit a BACnet Model.
• Users will be able to view the consolidated External Model which includes the Base model (Currently utilized in Site Manager), Modbus, and BACnet Models.
• Users will be able to select the protocol and export the model.
• Versioning is supported for all types of models.

| Viewing an External Base Model

The Features of the External Model Namespace are:

• It will provide a complete consolidated view of all models which are added in this namespace.
• Users will be able to view Base, Modbus, and BACnet Models.
• Viewing the Display Name of the models requires to be captured along with other standard parameters on the viewing page.
• Other items on the viewing page along with action items remain the same.

From the Modbus Models home screen.

• Click on the view icon to view any Modbus model.

The model details window displays details like the Manufacturer, Model name, description, Tags & Points constituting the model.

| Confirm the Availability of an External Model

Before adding a new External Model, from the domain modeler External Models screen 

• Search for the External model you wish to add, to confirm the availability of the External model or a similar External model.

The search results are displayed.

Note: The tool displays the search results, based on the keyword search in both the External model's name and Description field columns.

| Add a New Base Model

To add a new External Base Model, from the domain modeler External model's screen.

• Click Add Model.

The Add External model window is displayed.

• Enter the Manufacturer's Name
• Enter the External model Name.
• Enter the Display Name.

Note: The tool displays a message as to what is to be added as an External model name as below:

When different format names are entered.

Note: The tool displays a message for a unique name to be used for the new point

When already existing names are entered

• Enter a valid External model name.
• Enter a valid description for the External model.
• Enter a valid display name for the External model.

Selecting An Existing Model as Base for New Model

• Select an existing model, to reference the data as a base for the new External model. 

Once an existing model is selected as a base for the new External model, the points that constitute the Model and all the tags that constitute the points are displayed.

Note: The base model can be selected from all the existing External and Domain Models in the library.

Note: The tags associated with the point are displayed, with a distinction between the tags that can be deleted and tags that cannot be deleted.

• Delete the tags that are not required, simply by clicking the cross on the tag.
• Type and add more required tags as below.

More tags added.

Editing and Deleting Points from Existing Model

• Edit the points added from the base model by clicking the edit  icon.

• Make the necessary and possible edits to the points, like adding more tags, modifying the description, and modifying the kind of the point.

• Click Done to confirm the changes to the point.

• Delete the points added from the base model by clicking the delete  icon.

The point from the base model is deleted as below.

Adding More Points to the Model

• Add more points to the model using the Add Points field option.

The points list box is displayed.

• Search for specific Tags or locate them by scrolling through the list.

• Select the required tag from the list below.

• Click Done to confirm the additional points.

The points are added to the list of points.

Adding Child Equips to the Model

• Add child equips to the model using the Add Child Equips option.

The child equips list box is displayed.

• Search for specific child equips or locate them by scrolling through the list.

• Select the required equip from the list below.

• Click done to confirm the associated equips.

The child equips are added to the list and the model gets associated with the models as above.

You can further add, edit or delete the child equips by clicking the add, edit, and delete icon shown below as done for the points.

• Click Publish to confirm the new External model addition.

The new External model is added.

Note: Child equips of the same type can be added multiple times to the existing external model.

A similar child equip has been selected multiple times in the above External model from the add child equip list.

Editing Child Equips

The External model has the option to edit child equips for the corresponding equips which have been added as per requirement.

• Select the required child equip/equips to edit.

• Click on Edit

Edit Child Equip Page is displayed.

The child equip name, domain name and description can be edited to suit the user's requirements.

Protocol Selection

An external model will be available to the user as an external base model in default. The user can further choose a protocol either between Modbus or BACnet model once the base external model is published.

• Select the protocol as a Modbus or BACnet model or retain it as the base external model.

| Edit an Existing Base Model

To edit an existing External Model, from the domain modeler External Models screen.

• Locate the External Model to be edited.
• Click the edit  icon.

• Make the necessary edits, using the steps specified in the Add New External Model Section.

• Select the Protocol as an External Base model, Modbus model or a BACnet Model

• Click Save as Draft to save it as a draft for later.

• Click Publish to confirm the edit and publish the changes.

| Delete Existing External Model

To delete an existing External Model, from the domain modeler External Models screen,

• Locate the model to be deleted.
• Click the delete icon.

A confirmation window is displayed to confirm the External model deletion.

• Click Submit to confirm the deletion.

The External model gets deleted breaking its association with the equips.

| Adding a BACnet model

BACnet models are required in Hayloft to enable seamless integration and interoperability between BACnet-based building automation systems and the Hayloft data modeling approach. Some advantages of BACnet models are:

• Standardized Data Representation: It allows for a standardized representation of BACnet data points, objects, and properties within the Hayloft framework. This promotes consistency and uniformity when working with BACnet data across different systems and applications. 
• Semantic Modelling: BACnet models in Hayloft provide a semantic layer that allows for easier interpretation and understanding of BACnet data.
• Interoperability: By incorporating BACnet models, Hayloft facilitates the integration of BACnet-based systems with other non-BACnet systems using a common data modeling framework. This promotes interoperability between different building automation systems and simplifies the exchange of data between them. 
• Data Tagging & Analytics: BACnet models in Hayloft provide a standardized way to tag and annotate BACnet data points, enabling more efficient data analytics, visualization, and reporting across diverse building systems.
• Simplified Application Development: Hayloft enhances application development for building automation by integrating BACnet data models, offering developers a standardized and structured approach to work with BACnet data. This simplifies the creation of software applications, including advanced analytics, visualization tools, and energy management systems within the Hayloft ecosystem, streamlining access to and interaction with BACnet data.

Once a base model is published, the same can be used to add a BACnet model.

To add a new External Base Model, from the domain modeler External model's screen.

• Click Edit model.

The Edit external model window is displayed.

• Select the Protocol as BACnet

The BACnet model protocol is selected.

The corresponding points for the model are displayed.

Existing Points and tags can be edited similar to the base model.

Points can be added to a BACnet model similarly to the base model.

Child Equips can also be added to an BACnet model similarly to a base model.

The BACNet model is created and can be identified with a in the External model namespace.

| Viewing Change Logs

To view the change logs for External Model, from the domain modeler External Models screen.

• Locate the model to view the change logs
• Click the change logs  icon.
• Select the dates for the first version and the second version.

The change logs for the selected model and versions are displayed.

| Download External Model

To download the External models in the library.

• Click the Download icon.

The window to specify the download format displays.

Select the version which you want to download.

Select the format in which you want to download.

 

You can download the models in JSON, TRIO, and Zinc formats.

 

A sample for a JSON format downloaded:

 

A sample for a TRIO format downloaded:

 

A sample for a Zinc format downloaded:

Note: The Modbus model tab from the hayloft tool would be excluded once it achieves system stability in due course of time.

Important Points to Remember

• "his" tag should be added to all sensor and software points.
• "writable" tag should be added for all "user intent" points.
• "equip, room, floor, device, site, schedule, vacation" tags should not be added at point level.
• For energy/electric meter, the "emr" tag should be added for all equips and points.
• For BTU meter, the "btu" tag should be added for all equips and points.
• "spaceRef" tag should not be added to the external models.
• "logical" tag should not be added at the point level.