Project

General

Profile

Javascript » History » Revision 9

Revision 8 (Torbjorn Carlqvist Admin, 09/01/2021 02:32 PM) → Revision 9/28 (Torbjorn Carlqvist Admin, 09/01/2021 03:33 PM)

h1. Javascript guide for DTXr code IDE 

 Shows the various commands and events that can be used to build automation scripts. 

 


 h2. Commands 


 h3. *print*    - Prints a message to footer log window as well as the automation.log file 

 <pre><code class="javascript">print("hello");</code></pre> 

 h3. *readProperty*    - Reads an object property value 

 <pre><code class="javascript"> 

 /*********************************************************************************************** 
  * @param {Number} device - The device id 
  * @param {Number} objectType - The object type. Both id and enumerated names can be used. 
  * @param {Number} objectInstance - The object instance. Must be a positive number. 
  * @param {Number} propertyId - The property id. Both id and enumerated names can be used. 
  ***********************************************************************************************/ 

 //Reads a present value from analog input object 0. 
 Controller.readProperty(85343,analogInput,0,presentValue); 

 //Use the result to print and in logic 
 res = Controller.readProperty(85343,analogInput,0,presentValue); 
 print(res); 
 if ( res > 0 ){ 
   print("value larger than 0!"); 
 } 
 </code></pre> 

 h2. Events 

 h3. *eventNotificationReceived* - Called when an intrinsic report notification is received. 

 <pre><code class="javascript"> 
 /*********************************************************************************************** 
  * @param {Number} device - The device that send the event 
  * @param {Number} objectType - The source object of the event 
  * @param {Number} objectInstance - The instance of source object 
  * @param {Number} eventType - The type of event received 
  * @param {String} fromState - The previous state 
  * @param {String} toState - The current state after the change 
  * @param {Object} eventValues - A map of specific values for this particular eventType  
  ***********************************************************************************************/ 
 function eventNotificationReceived(processIdentifier,initiatingDevice,object,objectType,objectInstance,timeStampUTC,notificationClass,priority,eventType,messageText,notifyType,ackRequired,fromState,toState,eventValues){ 
 //Use this event to act on notifications that is set to be subscribed by this device. 
 } 
 </code></pre>