Rules/Post

The AlarmInstance that is triggered may use fields from the Rule that triggered it and/or from the Device itself.

If the message field is filled out, then this message is used in the Alarm. If not, then the default AlarmInstance message is used.

For example, to record in a log that an email was sent, an air conditioner was turned off and so on.

The contents of the message field are recorded in the log.

The EventLogEntries/Get endpoint can be used to retrieve the contents of the log.

“CommandProperties” : {

“commandId” : “54456c3e711206b0f932e4”,

“message” : null,

“commandArgument” : “{“name”:”Off”}”,

“deviceIds” : [

“5859b04442231f0111366a6a1”

]

}

The Device software or the Axonize SDK on the Device must be listening for this command in order to execute it when it is received.

For example, let’s say that you have a Rule that applies to all refrigerators, which is to be triggered whenever the temperature of one of the refrigerators in the group exceeds 20°. This means that you do not need to create a comparable rule for each refrigerator individually. In this case, whenever the temperature of one of the refrigerators in the group exceeds 20° degrees, the command is executed on that device.

This feature enables you to link up to any system that has an HTTP endpoint. This feature can be used to integrate with your existing servers.

This means that any internal process that you have in your organization can be looped in through a web service action. This action sends an HTTP call when a Rule is triggered, and then you can use your own logic in your own system to trigger any desired action.

“WebServiceProperties”:{

“url” : “https://sprinkles.com/api/commands/sendCommand”,

“method” : “POST”,

“headers” : [

{

“key” : “customerId”,

“value” : “3423423db20422f29”

}

],

“body” : “{\”commandId\”:\”4\”}”,

“contentType” : “application/json”

}

For example, if the Product defines a property called Color, then all Devices of that Product have that property. A Rule can specify that if the temperature of a specific Device goes over 80 degrees, then the value of the additionalProperty named Color is changed to Red.

For example, if the rule triggered it will increase the property by two.

• Plus
• Minus
• Multiple
• Division
• Percent

“ruleRecurrenceSettings” : {

“repeatFrequency” : NumberInt(5),

“maxNumberOfOccurrences” : NumberInt(5)

},

• Device level (for one or more Devices).
• Product level applies to all the Devices of this Product.
• Application ID level. This level applies for all Devices for a given customer.

For example, a condition could be defined at the Product level for refrigerators and there are 50 refrigerators of this Product. The Rule triggers the sending of a text message if the refrigerator temperature exceeds 15 degrees. This means that every refrigerator (meaning each of the 50 refrigerators) belonging to this Product whose temperature exceeds 15 degrees will send a text message.

To define that multiple conditions must exist in a Device at the same time (AND) in order to trigger the Rule, then define multiple conditions in the same Rule. This only works at the Device level.

“conditions”: [

{

“id”: null,

“appIdForRule”: null,

“productId”: null,

“eventName”: “Temperature”,

“typeCode”: 7,

“threshold”: “19”,

“operator”: “>”,

“durationInMinutes”: 3,

“conditionCount”: 0,

“isRelative”: false,

“type”: “Threshold”,

“name”: “Temp > 19 for 3 minutes”,

“ruleTarget”: “Device Level Rule”,

“targetId”: “Axonize.Common.Models.NonSql.DeviceNode”,

“eventProductId”: null,

“devices”: [

{

“id”: “583ee9fa4e41868148e409bd”,

“name”:

“BT Temp 3”

}],”locationConditionSettings”: null

}

],

“ruleRecurrenceSettings”: null

}

Specifying a value here means that the Rule applies to the Application ID level.

Specifying a value here means that the Rule applies to the Product level.

Axonize works on a combination of eventName and typeCode (described below).

Axonize works on a combination of eventName and typeCode (described above).

If eventName is not specified, then the condition applies to all events with the typeCode specified here, regardless of their eventName.

Numeric operators are shown below –

“>”:

“<“:

“=”:

“!=”:

“>=”:

“<=”:

String operators are shown below –

“=”

“!=”

For example, a Rule can specify that an SMS is sent after 5 minutes (duration) if the temperature of a refrigerator is over 20°. In this case, the temperature must be over 20° for the entire 5 minutes in order for the SMS to be sent.

Duration conditions can only be used at the Device level.

Consecutively means that each consecutive reading received by Axonize meets the condition.

For example, a Rule can specify that a temperature must be over 20 degrees in four consecutive readings.

Before this Rule has ever been triggered for a specific Device, the first reading is the anchor. This means that the first reading is the value compared to which all the latest readings are compared.

After the Rule is triggered for a specific Device, the reading that triggered the Rule becomes the new anchor against which all future readings are compared.

• Threshold – Indicates that the condition is triggered based on Threshold (this is the default).
• Location – Indicates that the condition is triggered based on Location (as described in locationConditionSettings below).
• Instantaneous – Indicates that the condition is an instantaneous one.
• Property – Indicates that the condition is triggered when comparing a reading value to a property or setting value. When using this value, the name of the property to which you want to compare should be placed in the conditions/threshold property. The condition and the condition name should reference the reading to which you want to compare.
• PropertyAndStatic – Indicates that the condition is triggered when comparing between a property/
  setting and a static value that you provide in the conditions/threshold described above. This condition is evaluated every time the property or setting is changed. For example, if fan speed is set to High. When using this condition type, the conditions/typecode should be set to 70000.
• Reading – Compare between the input reading to other reading (Need to define field readingCondition if you choose this type)

• Device Level Rule
• App Level Rule
• Product Level Rule

{

“id” : ” 599463f13f8c96478014f1c0 “,

“name” : “Fridge20”

}

Specifying a value here means that the Rule applies to the Device level.

When specifying a value here, you cannot also specify an operator or threshold.

locationConditionSettings:{shouldBeInside: true, latitude: “32.0910665”, longitude: “34.78774490000001”, radius: 0.5}

When shouldbeinside is False, the Rule is triggered when a Device is outside the geo-fence circle.

• Plus
• Minus
• Multiple
• Division
• Percent

When specifying a value here, you cannot also specify an operator or threshold.

locationConditionSettings:{shouldBeInside: true, latitude: “32.0910665”, longitude: “34.78774490000001”, radius: 0.5}

When shouldbeinside is False, the Rule is triggered when a Device is outside the geo-fence circle.