Using Replacement Variables
Replacement variables are a series of special characters that you can use in text being spoken or in the subject or body of an email. When HomeSeer encounters one of these variables, it substitutes the information indicated by the variable in place of the variable.
Example
hs.Speak "The time is $$time"Results in (at 11AM): "The time is 11:00 AM"
HomeSeer Replacement Variables
Replacement variables are case insensitive.
$date | Replacement is the current date in long format, e.g.: April 1, 2006 |
$time | Replacement is the current time in 12 hour format, e.g. 2:00 PM |
$$date | Replacement is the same as $date, but it is wrapped with the SAPI context tag for date so the text to speech engine knows it is a date being spoken. Use $$date when the output is going to be spoken. |
$$time | Replacement is the same as $time, but it is wrapped with the SAPI context tag for time so the text to speech engine knows it is a time being spoken. Use $$time when the output is going to be spoken. |
$from | Replacement is the email address of the last email received. |
$$DVA:(address): | Replacement is the VALUE of the device indicated by (address). For example, if the device at address R40 has a value of 100, then using $$DV:R40: in the text will result in 100 after the substitution. |
| $$DVC:(code): | Same as $$DVA but gets the device value using the device code. |
| $$DVR:(ref): | Same as $$DVA but gets the device value using the device reference number. |
$$DSA:(address): | Replacement is the STATUS of the device indicated by (address). For example, if the device at address S39 has a status of "Disarmed", then using $$DSA:S39: in the text will result in "Disarmed" after the substitution. |
| $$DSC:(code): | Same as $$DSA but gets the status using a device code. |
| $$DSR:(ref): | Same as $$DSA but gets the status using a device reference number. |
| $$DTA:(address): | Replacement is the STRING of the device indicated by (address). For example, if the device at address S39 has a string of "Come listen to a story about a man named <b>Jed</b>", then using $$DTA:S39: in the text will result in "Come listen to a story about a man named Jed" after the substitution. Note: HTML used in the status may result in problems when the replaced text is spoken. |
| $$DTC:(code): | Same as $$DTA but gets the string using a device code. |
| $$DTR:(ref): | Same as $$DTA but gets the string using a device reference number. |
| $$LCI: | (Windows Only) Replacement is information about the last phone caller, caller ID information. |
| $$CIN: | (Windows Only) Replacement is the caller ID name of the last call. |
| $$CI#: | (Windows Only) Replacement is the caller ID number of the last call. |
| $$LVM: | (Windows Only) Replacement is the last voice message that was left (who left it, when it was left, and how long the message was) |
| $$COUNTER:(name): | Replacement is the value of a specific counter. If you have a counter named "dryer_counter" then you could speak the value of this counter with: $$COUNTER:dryer_counter: |
| $$TIMER:(name): | Replacement is the value of a specific timer. If you have a timernamed "dryer_timer" then you could speak the value of this timerwith: $$TIMER:dryer_timer: |
| $$GLOBALVAR:(name): | Replacement is the value of the named global variable. |