Print to Log Driver

Print to Log will print user messages to the XP Diagnostics log. The message output capabilities are expanded to allow real time reporting of system status using other driver's variables. How cool is that?!

Configuration

· You can reference other driver's variables, and up to 50 each Flag, Integer and String variables can be brought into this driver. You can name these for use when referencing them during the message Print to Log function, 'Print To Log', as defined below.

o You can enter true and false phrases for the flag variables by adding a colon after the name followed by the true phrase, followed by another colon and then the false phrase. For example: "Power State:on:off", or "Vacation Mode:Enabled:Disabled".

Functions

· Print To Log – Use this to print a message that you enter. You can use other driver's variables as outlined below.

- Message is the message that you want to print

- Log Level is the level of detail that you can show in XP Diagnostics.

Connections, User Actions, and Messages are the levels from least level of detail to the highest level of detail. You can choose what level of detail and include as many messages as you deem fit for your application. In practice, however, you probably want to always show the message and the default of "Connections" will be the level of detail you want to use. You can turn off all message output for this driver by selecting "None" in XP Diagnostics for this driver.

Message Variable References

In your Logged messages you can use variable reference keywords to include other drivers' flag, integer and string variables in your spoken output. Set the other driver's variable references in configuration as defined above.

Flag References are included in messages by using the keyword <F#> where # is the number of the flag variable (1 to 50). Integer References are included by using the keyword <I#> and Strings are referenced by using the keyword <S#>. Be sure to include the angle brackets around the keywords.

You can also enter a NAME for each driver flag, integer or string variable and reference them by using your entered name. You can reference Current Date and Current Time from the Clock 3.4 driver and call them Date and Time. Reference named variables by including the angle brackets around your names.

Names are not case sensitive, so 'Time' is the same as 'TIME' and 'time' and 'tImE'.

In the Flag NAMES, you can add a word or phrase to print if it's true and another word or phrase to print if it's false (rather than printing 'true' or 'false'). Do this by separating the true and false words by a colon. For example, the name might be "TV On:On:Off" and it will print 'On' if the referenced flag is true (the TV is in fact ON).

Some examples are:

House is too hot at <I12> degrees!

Frigging alarm is going off again. Front door open state is <F1>. Alarm Panel shows <S10>.

Main amp is blasting at <MainVol> Db. Call Junior or tell Ace to turn it down.

Downstairs it is <downstairsTemp> degrees and upstairs it is <upstairsTemp> degrees.

Notes/Tips

1. Only US ASCII printable characters, (letters, numbers and spaces only) are supported by this driver. This means punctuation and international characters such as Ñ, æ, ä, ë, ï, Ü, etc. are not allowed and will be ignored.

2. You can put commas in your messages in the Print To Log command.

Version History

1.00 Initial Release