Add Device(s) to DeviceHub for multiple Litmus Edge

to add device(s) with litmus excel add ins, you should be familiar with how devices work in devicehub docid\ tgmyvezsra7ydtegxdvv4 on litmus edge before you begin you have installed the litmus excel add ins extension see install litmus excel add ins docid\ gzdhbj1xzznddthyocuuu for details you have prepared a prepare a new tool file to manage devicehub device(s) on multiple litmus edge docid 0m77drmbjd gybmtiwqwa initial preparation open a new device management tool file in excel if prompted, enable content to allow the code to run make sure the the tool is set to fast mode for the create device name option and connect to is set to multiple le add device(s) in fast mode notes every driver will have their own set of device properties depending on the respective protocols the steps below show an example using one of the over 100 drivers mandatory device settings set the target litmus edge ip enter the ipv4 of the litmus edge you want add the device on into column target litmus edge ip notes if no api key for the device was previously provided, the user will need to provide the api key the three d's provide the following three device settings to start the definition of a device driver group name select the driver group of the driver for your plc driver name select the driver with which to connect to your plc device name provide the name for the device notes the tool will verify that the entries for this column are unique and notify the user in case the same device name was already used the tool will automatically pull the default settings for the driver similar to how the ui on litmus edge prepopulates the device wizard it is recommended to click the compare vs le button to check if a device with the provided driver and name may already be defined on litmus edge if no device with the selected driver and name combination is defined, the row will stay as a for the action if a device with the selected driver and name combination is already defined, the row will change to m for the action and the settings of the device will be pulled notes this doesn't need to be done for every device individually but can instead be done once all desired devices have been added to the sheet device properties device properties are a mandatory set of device settings, which are populated initially with a set of default values to connect to your plc, you will have to provide your specific device properties settings instead which you can provide through one of two options option 1 you can provide your specific device properties directly through the formula bar or through the cell you will need to be careful to not remove any of the key value pairs as well as keeping the json formatting accurate option 2 you can use the device properties wizard docid\ qn07nz6dlfdz1mdpqkijc the device properties wizard allows you to edit the device properties without the risk of potentially invalidating the json object if all add device(s) to devicehub for multiple litmus edge /#mandatory device settings ( ) device settings are provided, as well as all add device(s) to devicehub for multiple litmus edge /#not mandatory device settings settings are changed, the device is ready to be added to litmus edge notes to add more devices to the sheet, repeat the process described under add device(s) to devicehub for multiple litmus edge /#add devices in fast mode for every device you want to add executing actions when all add device(s) to devicehub for multiple litmus edge /#mandatory device settings and add device(s) to devicehub for multiple litmus edge /#not mandatory device settings settings for all device(s) are set, they are ready to be added it is recommended but not mandatory to verify the configuration first without executing the action by pressing the verify only button this will check that all required device settings are provided and logically correct and provide any finding to the user example below the user did select to have meta data but did not provide any important the tool can not verify if all provided device settings are factually correct for example it can not verify that the network address provided for the plc is the correct ip address the device(s) can be added to litmus edge by pressing the verify + execute button the tool will group all the devices based on the litmus edge(s) defined in column target litmus edge ip for each litmus edge this will check that all required device settings are provided and logically correct and provide any finding to the user if no issues have been identified, the tool will verify that the user wants to execute all the actions from the action column for this device a add device(s) m modify device(s) d delete device(s) i ignore device(s) > do nothing to perform all actions for the litmus edge, press the yes button the tool will perform all actions row by row for the litmus edge when finished, a result summary is shown for each litmus edge close the result summary by pressing the x close button to continue with the next litmsu edge once all litmus edge have been processed, the tool will ask if the user wants to re compare the device(s) against litmus edge to re compare, press the yes button to not re compare, press the no button if the user selected to press the yes button from aboves messagebox , the tool will pull all the device settings from litmus edge again including the deviceid and also change the action to m for each device with a deviceid or a for devices with no deviceid not mandatory device settings each device has a number of not mandatory settings which can be used to meet specific needs device description a short description of the device enable meta data select if you want to add meta data to the device connect a device docid\ ish7bqhzxswtdx8vbnszb provide a json object which holds all the meta data you want to add to the device see organize device and tag data by using metadata docid\ si z6r5dzyyuyhlwzq4zr to learn more it is recommended to use the meta data wizard docid\ tecprcmt6i2kyopth9dfz enable status register select if you want to add a status register which is used to monitor if the device is reachable instead of the default status check mechanism connect a device docid\ ish7bqhzxswtdx8vbnszb provide the register definition as a json object it is recommended to use the status register wizard docid\ hh2cpcevkhumoftzyqfpm connect a device docid\ ish7bqhzxswtdx8vbnszb select if you want to substitute long, unreadable device and tag ids with human readable device and tag names in topic names connect a device docid\ ish7bqhzxswtdx8vbnszb select if you want to e nable the logging option for gen 2 drivers note for gen 1 drivers this option is unavailable connect a device docid\ ish7bqhzxswtdx8vbnszb select if you want to store the collected data locally data store retention period provide the number of hours the data are to be stored optional settings this provides a json object which allows users to set settings like connect a device docid\ ish7bqhzxswtdx8vbnszb select if for gen 2 drivers the driver will always publish messages according to the polling interval configuration connect a device docid\ ish7bqhzxswtdx8vbnszb select if the driver will be monitored based on the watchdog period connect a device docid\ ish7bqhzxswtdx8vbnszb select if for some gen 2 drivers (opc ua, bacnet, dnp3, modbus) additional information such as source timestamp, server timestamp and status code it is recommended to use the optional settings wizard docid 2evk5vhpfjzhd9fmso95q add device(s) in extended mode make sure the the tool is set to extended mode for the create device name option provide the following three device settings to start the definition of a device driver group name select the driver group of the driver for your plc driver name select the driver with which to connect to your plc the device name can now either be provided directly in the column device name or can be build using four parameters line / cell the line or cell at the site at which data is being collected if the value provided is just a number the letter "l" will be set as a prefix device / plc the device or plc on the line which holds the data to be collected equipment id / operation number the machine or asset attached to the plc which is generating the data component / version number a granular part of the equipment which is generating data the device name is build using each of the 4 parameters separated by a " " example notes it is still possible to add the device name directly same as when add device(s) to devicehub for multiple litmus edge /#add devices in fast mode setting add device(s) to devicehub for multiple litmus edge /#device properties , add device(s) to devicehub for multiple litmus edge /#executing actions as well as setting add device(s) to devicehub for multiple litmus edge /#not mandatory device settings the process is the same as for add device(s) to devicehub for multiple litmus edge /#add devices in fast mode troubleshooting the tool will perform several checks throughout the proces of defining the device settings if they do not pass successfully, the user will be notified the checks include device name uniqueness the tool checks if a combination of target litmus edge ip and device name already exist in the tool allowed and not allowed ascii characters for names and descriptions docid\ fnwhcidrnnpizczkuwiyz for device names and descriptions the user is shown a message box as notification the character(s) are highlighted in red and also shown in a note see allowed and not allowed ascii characters for names and descriptions docid\ fnwhcidrnnpizczkuwiyz for a full list for both names and descriptions correct json formating for device properties , meta data , status register and optional settings example for an invalid json formatting of the device properties valid entry for data store retention period to be a number and withhin allowed range example for an invalid entry for the retention period do exist json key value pairs in columns device properties , optional settings or status registers with a value being empty null empty array " \[] " empty json object " {} " are the columns device properties , optional settings or status registers empty if they are, the default json object will be automaticlly added