If a module doesn't already have an .rvc file, one can be created easily. An .rvc file is a plain text file containing some information regarding the module and the devices it supports. The file can be created using Notepad or any program editor. (Word processors such as Word are trickier to use, since by default they want to add formatting information to the file that Omniscope can't read.)
A typical .rvc file looks like this:
Description = PowerTech Configuration Tool
File = PowerTechTool.exe
Address = 64
DefAddress = 64
Make = POWERTECH
EOF
Revised 12/25/07
Each line has a similar syntax, except the EOF. The EOF indicates "end of file" - any text after the EOF is ignored. Each line consists of a variable name, an equal sign, and a value associated with that name. The meaning of each variable is as follows:
Description - The value indicates the text that will be shown in Omniscope's Module Box, and is how the user will see the module. This should be as descriptive as possible.
File - The value indicates the name of the program to be run. This must be a Windows executable (.exe) file.
Script - The value indicates the name of the script to be run. This must be a valid Omniscope (.scp) file. Only one module (file and/or script) can be used in an .rvc file.
Address - This determines what source address the device must have to be associated with the module. This can be a specific address, or a range such as 0-255. Note that in most cases a device's address is unpredictable. An Address value must always be supplied - use 0-255 if any address is acceptable.
DefAddress - This determines what DSA (default source address) the device must have to be associated with the module. This can be a specific address, or a range such as 0-255. The DSA identifies the general type of device (e.g. inverter, generator), but it does not indicate the manufacturer. A DefAddress value must always be supplied - use 0-255 if any product type is acceptable.
Make - This associates the module to a specific Make, as broadcast in the device's PRODUCT_ID. The match must be exact, but question marks can be used as "wildcards" to allow an inexact match.
Model - This associates the module to a specific Model, as broadcast in the device's PRODUCT_ID. The match must be exact, but question marks can be used as "wildcards" to allow an inexact match. This technique is useful for identifying a family of products or version numbers. For example, "Make = QD??" would match a QD12, QD15, or QD18. It would not match with QD9, however, since the length is not the same.
Node designers thus are advised to be consistent in the naming of their products models when devising their PRODUCT_IDs.
SN - This associates the module to a specific serial number, as broadcast in the device's PRODUCT_ID. Like Make and Model, question marks can be used as "wildcards" to allow an inexact match.
ID - This associates the module to a specific ID number, as broadcast in the device's PRODUCT_ID. Like Make and Model, question marks can be used as "wildcards" to allow an inexact match.
Params - If the module is a Windows .exe file, this value provides a set of command-line parameters that the program may require. If the module is an Omniscope Script, this value becomes the parameter list that the script can examine using the PARAMS tag. This makes it possible to use the same script for multiple purposes, or to make certain parts of a script optional. Note that any module can have multiple .rvc files associated with it. Creating several .rvc files with different parameters that all activate the same module is often simpler and easier than making multiple modules.
Message - This value is used to merely send a message, rather than start a module. For example, the following .rvc file allows the technician to start the generator from Omniscope without starting a module.
Description = Start Generator
Address = 0-255
DefAddress = 64
Message = 1FFDA 01 FF FF FF FF FF FF
EOF
(note: the DSA for a genset is 64)
Command - This is the same as Message, but Omniscope also waits for an acknowledgement of the command.
When working with .rvc files, note that Omniscope reads all the .rvc file in its directories when it starts up. Changes made to the files after Omniscope has already started won't be reflected in the program. After adding or changing an .rvc file, shut down and restart Omniscope to see the effects of the changes.