# BundleUtil confusion - ModbusDriverExample shows incorrect name/description **URL:** \ **Category:** Module Development\ **Created:** [August 22, 2019, 5:08pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676 "2019-08-22T17:08:48Z")\ **Posts on this page:** 18\ **Page:** 1
**Author:** ![systemparadox](https://avatars.discourse-cdn.com/v4/letter/s/b5e925/32.png) [@systemparadox](https://forum.inductiveautomation.com/u/systemparadox)\ **Post date:** [August 22, 2019, 5:08pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/1 "2019-08-22T17:08:48Z")
I am looking into implementing a driver but I am completely confused by the localisation system, BundleUtil, etc. I tried building and installing the ModbusDriverExample and it seems that it doesn’t work there either. Instead of using the `Modbus.properties` file, the “Create new device” page shows the following text: ```auto Modbus.ModbusRtuOverTcpDriverType.Name Modbus.ModbusRtuOverTcpDriverType.Description Modbus.ModbusTcpDriverType.Name Modbus.ModbusTcpDriverType.Description ``` Note: I am using the ignition-7.9 branch of the ignition-sdk-examples repository. The documentation for DriverType states that this takes a nameKey and descriptionKey which will be passed to BundleUtil. Is this correct? Perhaps these should just be plain strings? Or is there something wrong with the example? An issue with the build scripts? An issue with my build environment? Also, please could somebody review the documentation for BundleUtil. It’s not clear at all how this works. - What class am I supposed to pass to addBundle? How do I add a single properties file that’s available to all the classes in my module? - Why does the shortcut say it’s equivalent to passing `clazz.getClassLoader()` instead of just `clazz`? - Why do the example modules have the `.properties` files in a separate `src/main/resources` tree? Do we have to do this? Aside from being horrible it also contradicts the documentation which states that the `.properties` files should be alongside the `.java` files. Thanks. ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [August 22, 2019, 5:19pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/2 "2019-08-22T17:19:10Z")
In this case, it seems like the problem is that `Modbus.properties` _isn’t_ in `src/main/resources/parallel/path/to/ModbusDriver.java`. If you move it and then `mvn clean package` it should build a driver that loads the properties file correctly. As far why it’s that way … it just is. That’s Maven convention. ---
**Author:** ![systemparadox](https://avatars.discourse-cdn.com/v4/letter/s/b5e925/32.png) [@systemparadox](https://forum.inductiveautomation.com/u/systemparadox)\ **Post date:** [August 22, 2019, 5:38pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/3 "2019-08-22T17:38:50Z")
```auto mkdir -p ModbusDriverExample/mde-gateway/src/main/resources/com/inductiveautomation/xopc/drivers/modbus2/ mv ModbusDriverExample/mde-gateway/src/main/java/com/inductiveautomation/xopc/drivers/modbus2/Modbus.properties ModbusDriverExample/mde-gateway/src/main/resources/com/inductiveautomation/xopc/drivers/modbus2/ mvn clean package ``` Uninstalled module (is this necessary?), uploaded new module. No change. ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [August 22, 2019, 5:40pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/4 "2019-08-22T17:40:09Z")
Any changes to properties files usually require a gateway restart to take effect. ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [August 22, 2019, 5:44pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/5 "2019-08-22T17:44:07Z")
It seems the properties files for the PersistentRecords are also in the wrong location. I don’t know if there was previously some configuration that made this work or if something went wrong when this got dumped and modified to be an SDK example. ---
**Author:** ![systemparadox](https://avatars.discourse-cdn.com/v4/letter/s/b5e925/32.png) [@systemparadox](https://forum.inductiveautomation.com/u/systemparadox)\ **Post date:** [August 22, 2019, 5:46pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/6 "2019-08-22T17:46:01Z")
Restarting the gateway has fixed it. That makes this impossible to debug. We don’t have a chance of getting this working on our own without better examples and better documentation. The whole thing is confusing enough as it is without the examples being wrong and nothing happening unless the gateway is restarted ☹ I would strongly suggest that the documentation should make it very clear that changes to properties files require a gateway restart. Although even better would be to make this work as expected! ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [August 22, 2019, 5:49pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/7 "2019-08-22T17:49:28Z")
I’ll relocate the properties files and update the 7.9 examples. FWIW, I think these extension point types are one of the only places you’re forced to use BundleUtil and deal with the localization/properties files. Even PersistentRecords are a little easier because they don’t require the properties file to be loaded with BundleUtil. Docs could always be better, of course… ---
**Author:** ![systemparadox](https://avatars.discourse-cdn.com/v4/letter/s/b5e925/32.png) [@systemparadox](https://forum.inductiveautomation.com/u/systemparadox)\ **Post date:** [August 22, 2019, 5:50pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/8 "2019-08-22T17:50:37Z")
My module is now working as well. It turns out I had fixed it, but I had no idea because I hadn’t restarted the gateway yet! ---
**Author:** ![systemparadox](https://avatars.discourse-cdn.com/v4/letter/s/b5e925/32.png) [@systemparadox](https://forum.inductiveautomation.com/u/systemparadox)\ **Post date:** [August 22, 2019, 5:52pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/9 "2019-08-22T17:52:15Z")
If there is some way to make these work in the same tree I would love to know about it. The separate parallel trees seem incredibly bug prone to me. ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [August 22, 2019, 5:53pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/10 "2019-08-22T17:53:35Z")
It’s a quirk of BundleUtil. Most other changes you would make will not require a gateway restart. I don’t know what you’re working on here, but I should at least warn you that this example is very dated and is not representative of how newer drivers are architected. Unfortunately I don’t have any good examples of this, in either 7.9 or 8.0, but I’m hoping in the near\* future to open source another driver example. Probably something simple like a Micro800 driver. But it will only be built for 8.0 and be an example for the new driver API in 8.0. \*this year? maybe? ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [August 22, 2019, 5:54pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/11 "2019-08-22T17:54:38Z")
[https://maven.apache.org/plugins/maven-resources-plugin/examples/resource-directory.html](https://maven.apache.org/plugins/maven-resources-plugin/examples/resource-directory.html) ---
**Author:** ![systemparadox](https://avatars.discourse-cdn.com/v4/letter/s/b5e925/32.png) [@systemparadox](https://forum.inductiveautomation.com/u/systemparadox)\ **Post date:** [August 22, 2019, 5:58pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/12 "2019-08-22T17:58:23Z")
I noticed the API for 8.0 looked quite different. Unfortunately I’m having to stick with 7.9 for this one. Or are you saying there is a better way of doing this in 7.9 as well? ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [August 22, 2019, 6:02pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/13 "2019-08-22T18:02:14Z")
10,000 foot view of what you should do different: 1. Protocol implementation should not be coupled to the driver implementation. For example, when I eventually rewrite the Modbus driver, I’ll just use [this implementation](https://github.com/digitalpetri/modbus) I built. The driver should just focus on the integration of some protocol into the OPC UA server. 2. Don’t extend from `AbstractDriver`, just implement the `Driver` interface directly. `AbstractDriver` is basically a state machine always trying to force a driver into the `Connected` state, among other weird things. It’s a design that we came up with over 10 years (!!!) ago, and has proved to be troublesome. ---
**Author:** ![pturmel](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pturmel/32/3295_2.png) [@pturmel](https://forum.inductiveautomation.com/u/pturmel)\ **Post date:** [August 22, 2019, 6:40pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/14 "2019-08-22T18:40:01Z")
> [@Kevin.Herron](#): > > Don’t extend from `AbstractDriver` , just implement the `Driver` interface directly. +1000000000. When I started my Ethernet/IP driver, I beat my head on the AbstractDriver for a while. 🥵 ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [August 22, 2019, 7:06pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/15 "2019-08-22T19:06:26Z")
@systemparadox make David send you to ICC this year so you can get all the advice you want in person. ---
**Author:** ![systemparadox](https://avatars.discourse-cdn.com/v4/letter/s/b5e925/32.png) [@systemparadox](https://forum.inductiveautomation.com/u/systemparadox)\ **Post date:** [August 23, 2019, 7:25am UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/16 "2019-08-23T07:25:46Z")
I think you mean Alasdair, but yes, I really should go to ICC sometime! > [@Kevin.Herron](#): > > Don’t extend from `AbstractDriver` , just implement the `Driver` interface directly. Ah that's good. I already decided that `AbstractDriver` didn't fit well with what we're doing so it's nice to know I'm actually on track instead of in the wilds. May I suggest at least updating the SDK guide to point new developers _away_ from `AbstractDriver` instead of towards it? Thanks. ---
**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\ **Post date:** [August 23, 2019, 11:12am UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/17 "2019-08-23T11:12:13Z")
> [@systemparadox](#): > > I think you mean Alasdair Oops 😳 Yes, I meant Alasdair. ---
**Author:** ![pturmel](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pturmel/32/3295_2.png) [@pturmel](https://forum.inductiveautomation.com/u/pturmel)\ **Post date:** [August 23, 2019, 3:00pm UTC](https://forum.inductiveautomation.com/t/bundleutil-confusion-modbusdriverexample-shows-incorrect-name-description/27676/18 "2019-08-23T15:00:44Z")
> [@systemparadox](#): > > I think you mean Alasdair, but yes, I really should go to ICC sometime! I could be convinced to cross the pond for some Module building consulting.... Maybe even a discounted rate.... (: