After unpacking and installing the framework, and modifying literals.js, to run the Driver Framework as supplied on the SmartServer IoT, perform the following steps:

  1. From a console connection, run the framework from the driver-framework directory ($APOLLO_DATA/driver-framework) using the following script:  node index.js

  2. For verbose messaging, run the framework using the following script:  node index.js -v 4

  3. You will need to create a suitable DTD file in CSV format to allow you to create a "logical device" in the CMS with the contents shown below (without any indents). You can do this using Notepad.exe:

    #filetype,dtd,,,,,,
    Device Type,Protocol,Program ID,Default App,Default Sys,Auto App Load,Auto Sys Load,Graphics File
    Driver Framework Test Device,IAP,900014420040DC00,,,FALSE,FALSE,,


  4. Then, import the DTD file using the Devices widget (see Collecting or Creating Device Interface (XIF) Definitions):



  5. At this point, you will be able to create, provision, and test an IOX device type in the Devices widget, and view and edit datapoints in the Datapoint Browser widget. Use any format for the UID when creating a device (see Discovering, Defining, or Importing Devices). You might wish to change this in your custom driver by modifying create_action.js: createActionValidator() as required.


    Create Device (first view)



    Create Device (second view)


  6. The following screen capture shows the console output after starting the application using verbose mode, and provisioning a device after it has been created in the CMS:



  7. After the device is created and provisioned, you can test it from the Device widget (see Testing Devices).


Once you have finished creating your custom driver, you can configure the supervisor to start it automatically.

See Configuring the Supervisor for more information.