Skip to main content

🔹 Parameter

After creating an object, users can define parameters of this object, such as "Voltage", "Temperature", "Switch"...etc. To add parameters, please refer to the following steps:

1. Basic flow​

  1. Edit an existing object parameter-1-01.png

  2. Select Parameter list of this object parameter-1-02.png

  3. Select + button, you can see that three kinds of parameters can be added:

    • Constant parameter
      • A parameter that with constant value.
    • Primitive parameter
      • A parameter, also called as I/O Parameter, that can bind with device tag and record tag value.
    • Calculation parameter
      • A parameter that can process simple arithmetic formula and system defined functions.

    parameter-1-03.png

  4. Select one kind of parameter and fill up Basic information and Alarm/Event(if necessary). parameter-1-04.png

  5. Select Submit to add a Parameter parameter-1-05.png

  6. Repeat step 4~5 to add more parameters parameter-1-06.png

  7. Click Cancel or back symbol < to go back to previous page parameter-1-07.png

  8. In Object list page, click object name or parameter count to go to Parameter list page. parameter-1-08.png

  9. In Parameter list page, you can check all parameters of this object. parameter-1-09.png

2. Data type of parameters​

You need to specify a data type of a parameter:

  • Number
    • Parameter value in 64bit double or 64bit integer format
  • Discrete
    • Parameter value in digital state, integer format, started from 0
  • String
    • Parameter value in string format

parameter-2-01.png

2.1. Data type - Number​

  • Specify the following attributes in Number data type parameter-2-02.png
    • Parameter name
    • Description
    • Data type = Number
    • Decimal places
    • Unit
    • Span low
    • Span high
    • Recording rate
      • Rate to record historical data
        • Do not record (default value)
        • 1 min
        • 5 min
        • 15 min
        • 30 min
        • 60 min
      • if user open the recording rate, EdgeHub will also record the hourly and daily data into database.
    • Recording type
      • Current
        • The original data of this parameter is randomly distributed between span high and span low. Such as "Temperature", "humidity", "Voltage"...
        • EdgeHub will record Maximum, Minimum, Last, and Average value of "Recording Rate", "Hourly", "Daily" data.
      • Cumulative :
        • The original data of this parameter is continuously growing, such as "Meter value".
        • EdgeHub will record Maximum, Minimum, Last, and Difference value of "Recording Rate", "Hourly", "Daily" data.
    • Maximum change rate / min(%) or Maximum change / min
      • Specify this value to prevent the abnormal data glitch.
      • Give Maximum change rate / min(%) in "Current" type.
      • Give Maximum change / min in "Cumulative" type.

2.2. Data type - Discrete​

  • Specify the following attributes in Discrete data type parameter-2-03.png
    • Parameter name
    • Description
    • Data type = Discrete
    • State list
      • Define the digital state of this discrete parameter.
      • Specify the descriptor of each state.
    • Recording rate
      • Rate to record historical data
        • Do not record (default value)
        • 1 min
        • 5 min
        • 15 min
        • 30 min
        • 60 min
      • if user open the recording rate, EdgeHub will also record the hourly and daily data into database.
      • In each time interval, EdgeHub records:
        • Duration of each stage.
        • Occurrance of each stage.

2.3. Data type - String​

  • Specify the following attributes in String data type parameter-2-04.png
    • Parameter name
    • Description
    • Data type = String
    • Recording data
      • Yes
      • No (default value)

3. Parameter type​

3.1. Parameter type - Constant​

  • Supported data type parameter-3-01.png
    • Number
    • Discrete
    • String
  • Additional attributes parameter-3-02.png
    • Default value
      • Default value of this parameter.
    • Reload data
      • Only shown in edit mode
      • You can specify whether to set the current value as default value or not.
        • Yes
        • No (default value)

3.2. Parameter type - Primitive​

  • Supported data type parameter-3-03.png

    • Number
    • Discrete
    • String

  • Additional attributes

    • Data source
      • You need to select a device tag to bind with this primitive parameter.
      • Click + in Data source field and select a device (the device must be created in Device Management or Data Connectors functions before) parameter-3-04.png
      • Select a tag of the above device parameter-3-05.png
      • Fill the rest of attribute field and click Submit to add this primitive parameter parameter-3-06.png

3.3. Parameter type - Calculation​

  • Supported data type parameter-3-07.png
    • Number
    • Discrete
  • Additional attributes
    • Calculation frequency (second)
      • The frequency to execute the formula and calculate the result for this calculation parameter parameter-3-08.png
    • formula
      • Read only, the value will be displayed after finishing Formula & code setting.
  • Additional setting - Formula & code
    • User can define their own mathematical formula in this tab page. parameter-3-09.png
    • In Formula settings field, write down your mathematical expression with variables, such as (a+1)%60 parameter-3-10.png
    • Click Check formula to check if this expression is valid or not parameter-3-11.png
    • if valid, it will parse the variables and display them in Code list. parameter-3-12.png
    • You need to specify the data source, which will be a parameter, of the variable, click + and pop out the data source list. parameter-3-13.png
    • Select a parameter of this object or other objects parameter-3-14.png
    • Switch back to Basic Information tab, you can see the formula field has been assigned. Fill the rest of attribute fields and click Submit to add this Calculation parameter parameter-3-15.png

On this page ...

Is this helpful?