Premise GetMailer Example

[video321]

Can someone please show me an example of how to use the GetMailer scripting function.
Ideally, I would like to have the ability for Premise to send out an email (dynamic for each zone if possible) whenever a zone on my M1 trips while the alarm is in an armed state. And another one to send at all times for my 24/7 sensors, such as water.

 

[123]

The GetMailer() method is only useful if you have a POP3 email account that does not use SSL. If you plan to use GMail or another email provider that employs SSL, you'll need to use my SSMTP module.


The attached file shows how to send an email whenever a SecurityZone is triggered and SecuritySystem is Armed.

1. Right-click a SecurityZone and select New > Script > PropertyChange
2. Select the SecurityZone's Triggered property.
3. In the Content window, enter what you want to happen when the Triggered property is activated.

Here's what the example uses:

if sysevent.newVal = true then
if Home.SecuritySystem.SecurityState = 0 then
  dim oMail
  set oMail = GetMailer()
  with oMail
   .From = "[email protected]"
   .To = "[email protected]"
   .Subject = this.path & " has triggered."
   .Body = this.path & " triggered at " & now
   .Server = "pop3.somewhere.com"
   .Send
  end with
  set oMail = nothing
end if
end if

Here's what it is doing:

• Confirming Triggered's state is true.
• Confirming the SecuritySystem's state is Armed.
• Sends email.

Here a SecuritySystem's valid SecurityStates:

• Armed = 0
• Disarmed = 1
• StayArmed = 2
• Alarming = 3
• Disconnected = 4

If you want the script to work at all times, get rid of "if Home.SecuritySystem.SecurityState = 0 then" plus its matching "end if". Alternately, you can just change it to "if Home.SecuritySystem.SecurityState >= 0 then" and it will work regardless of the SecuritySystem's state.


PS
The script uses the statement "this.Path". Here is what that means:

• "this" is the 'current object'. Another way of saying it is "me".
• "this.path" means the current object's full path name. The path of the example's SecurityZone is sys://Home/SecurityZone.

 

[video321]

So, does that mean I need to use 'this.path' or the specific path, such as sys://Home/SecurityZone? If I do use the specific path do I format it as such or as Home.SecurityZone?
Also, if I'm linking this script to each security zone, would I just use the 'this' statement since that is directly the zone I want to email status for?

 

[123]

Good questions!

Answer to question 1:
Use the expression this.path literally. It is is not a placeholder for you, video321, to put in something else. It is a placeholder for Premise to put the path of whatever object it is currently handling.

Answer to question 2:
Yes.

I wrote the code so that it is 'portable' and can be used within the PropertyChange script of any SecurityZone object (or similar object). Here's what would've made it non-portable:


If I had used:
.Subject = "Home SecurityZone has triggered."
instead of
.Subject = this.Path & " has triggered."
it would only make sense for one object, namely the Home SecurityZone object.

The expression "this.path" means the current object's full path name: sys://Home/SecurityZone.
"this.name" would produce the current object's name: SecurityZone.



If I had used
if this.Triggered = true
instead of
if sysevent.newVal = true
it would work exclusively with objects having a Triggered property (i.e. SecurityZone objects). For example, a MotionDetector object has a MotionDetected property (i.e. no Triggered property).

"Sysevent.newVal" means "this is the new value of the property I am monitoring". "sysevent.oldVal" means "and here's the previous value of the property I am monitoring".

 

[video321]

Got it.
Since you mentioned 'this.name' I'm sure I'd be better off using that since it will simply use the name of my security zone (Front_Door) instead of the full path within' Premise (sys://Home/SecuritySystem/Front_Door), right? Could I get it to use the 'Display Name' property (Front Door - with no underscore)?

Thanks, again, 123!

 

[123]

Yes.

If I were to create a SecurityZone object in Home > Foyer, call it 'FrontDoor' and then give it a DisplayName of 'Our Front Door' here are what it's major properties would be:

Class: sys://Schema/Device/Security/SecurityZone
Name: FrontDoor
DisplayName: Our Front Door
Path: sys://Home/Foyer/FrontDoor

"Class" is what the object is derived from. In other words, 'class' is like a recipe for chocolate cake. It's not a real chocolate cake until you follow the recipe and bake one. After baking it, you have a chocolate cake "object".

"Name" is the object's name and has to comply with Visual Basic's naming rules (no spaces, no special characters, cannot start with a number, etc).

"DisplayName" is the object's name for display in Premise Browser and anywhere else where you want a less-stunted name. TIP: If you use this.DisplayName in a script and forget to enter something in DisplayName, don't worry because Premise will default to using this.Name (very convenient).

"Path" is where the object is located in "Premise Space". Everything in Premise Space is organized in a hierarchy where "SYS" is the first object.



Premise takes 'object oriented programming' to heart. Every object in Premise inherits from "PremiseObject". That means PremiseObject's properties and methods are available in all other objects. It's kind of like if your grand-dad had red hair, was a great skater, knew how to speak Farsi, and balance pick-axes on his head, so would you and your offspring.

The attached image is from Premise's online Help and shows the Properties and Methods of PremiseObject. You'll note it has Name, DisplayName, Path, and several other properties. The fun one is "Parent". Yes, you can navigate your way up the family tree and display the name, and other properties, of each relative.

In the previous post above, this.Parent.Name would produce "Home", this.Parent.Parent.Name produces "SYS" and that's the biblical equivalent of Adam. If you persist and ask for this.Parent.Parent.Parent.Name, the script debugger pops up and throws a lightning bolt.

Every object also inherits PremiseObject's Methods. Whereas Name is the equivalent of your grand-dad's red hair (a trait), "GetChildren" and "SetValue" are like his ability to bend spoons with his mind and juggle bowling balls (whatta guy!).

 

[video321]

I understand...thanks to your analogies