Custom Sensor Properties

Custom sensor properties provide a method of storing custom parameters for sensors and TDUs beyond the properties provided as standard in the Ubisense dataset, for example to store additional information about sensor locations or unusual configurations. This enables you to maintain all information relevant to your DIMENSION4 sensors in a single location, and with the ability to export this to other sources.

Custom properties are added to the dataset using the ubisense_ls_sensor_properties admin tool, and can be of the type bool, choice, double, int, string, time or timespan. After custom properties have been added, they can be displayed in the Custom sensor properties tab using user-configurable views which can contain a mix of standard and custom properties. You can edit the contents of custom properties (and the standard comment property) in the Custom sensor properties tab.

You can export data for selected sensors from a view, and import custom properties from external sources, in CSV format.

Creating Custom Sensor Properties

Use the ubisense_ls_sensor_properties_admin tool to add custom sensor properties.

You can download this tool using the Application Manager: go to the DOWNLOADABLES tab and open Ubisense > Location system > Administration tools to find it. See the instructions for installing Client Machines for information on downloading tools.

You can add properties of the following types:

  • bool
  • choice
  • double
  • int
  • string
  • time
  • timespan

For each custom sensor property you want to add, run the ubisense_ls_sensor_properties_admin tool and specify the property type and description. For example to add a boolean property called new, use the command:

ubisense_ls_sensor_properties_admin create bool new

For properties of the type choice, you also specify the list of options. For example, the command:

ubisense_ls_sensor_properties_admin create choice color "Black" "White" "Grey"

creates a color property whose values can be black, white or grey.

If you create properties, you will need to restart any instances of LSC before you can see them.

Adding and Editing Views

You can choose properties for display, and the default order in which columns of data are shown, and save them as views. Before you can include custom sensor data in a view, you must have added the necessary properties to your dataset.

To create a view:

  1. Click Create new view to display a list of columns available for inclusion in the view.

    The list includes columns for properties supplied with your installation along with columns for any custom properties that have been defined.

  2. Give the view a name.

  3. Select columns for inclusion and click Add >.

    • Remove columns by selecting them in the selected columns list and clicking < Remove.
    • Select multiple columns by holding down Shift or Ctrl and clicking on them.
  4. Select columns in the Selected columns list and use the Move up and Move down buttons to change the order in which they display.
  5. When you are happy with your choices, click Save.

Editing a View

You can edit a view by selecting it from the <Select a column view> dropdown and clicking Edit selected view. Add and remove columns and change their display order as described above.

Deleting a View

To delete a view, select it from the <Select a column view> dropdown and click Edit selected view. Select Delete view and click Save.

Viewing Custom Sensor Properties

You choose how you want to display sensor information by choosing a view (see Adding and Editing Views for information on defining the content of a view) and selecting the sensors you are interested in.

To display custom properties for selected sensors:

  1. Open the Custom sensor properties tab.

    A list of sensors is shown. This will either be all sensors, or a selection displayed using the Show selected button in this, or another, tab.

  2. Choose a view from the <Select a column view> dropdown. The columns for properties included in the view are displayed.

    • You can change the order in which columns are displayed by dragging column headings. Save the new arrangement by clicking Save column order and this will become your default layout when you next select this view. (You can return to the predefined order of columns by clicking Revert column order.)

  3. Refine the selection of rows by typing text to search for into <Select matching rows>—the search is case sensitive. All rows with matching text in any of the columns are highlighted.

    • Use the Show groups checkbox to toggle between a list of sensors and a tree view of sensor groups and sensors.
    • Sort on a column by clicking in its heading.

Editing Custom Properties

Custom properties, and the standard Comment property, are editable.

To edit a custom property, slowly double-click it and type in the field or choose from a dropdown of available values.

You can add identical information for multiple sensors: select the sensors, by holding down Shift or Ctrl and clicking, and then double-click one of your selections or press Enter to open the editor.

 

Importing Custom Sensor Properties

You can import custom property data for sensors from a CSV file. Before you can import custom sensor data, you must have added the necessary properties to your dataset.

The following constraints apply to importing custom sensor properties:

  • The import process does not recognize sensors that are not already part of your dataset and does not import data associated with them
  • Only custom properties and the standard comment property can have their values updated by the import; other properties are not changed

The CSV file must contain data formatted as comma-separated strings enclosed in quotation marks. The first row of the import file contains the names of the properties to be imported. It is important that the format is correct, as if the import process detects an incorrect format, the import will fail.

You must also take care to ensure that values supplied for custom properties are of the correct type. Otherwise, the import will fail.

To import custom sensor properties:

  1. On the Custom sensor properties tab, click Import rows.

  2. Type the name of the CSV file or browse to its location.

  3. Decide how unknown data is handled:

    • Select Ignore unknown properties to allow the import process to ignore properties that are not configured in your dataset. If this is not selected, and unknown properties are encountered, the import will fail.
    • Select Ignore unknown sensors to allow the import process to skip data for sensors that do not belong to your dataset. If this is not selected, and unknown sensors are encountered, the import will fail.

  4. Click Import.

Exporting Custom Sensor Properties

You can export a selection of custom sensor properties to a file in CSV format which can then be used in other applications.

To export custom sensor properties:

  1. On the Custom sensor properties tab, display the sensors and properties to be exported. See Viewing Custom Sensor Properties.

  2. Click Export rows.
  3. Type the name of the file or browse to its location. Select Overwrite existing file if necessary? to replace a file that already exists.

  4. Click Export.