1 Naming a module {#naming} 2 =============== 3 4 UPM attempts to follow a clear naming pattern. Modules should be sensibly named 5 and then placed in ${libdir}/upm and headers in ${includedir}/upm, all modules 6 should be prefixed with libupm-<modulename>. The upm_module_init will 7 automatically name python UPM modules as pyupm_<modulename> and javascript 8 modules as jsupm_<modulename>. For example for src/grove/ the library built 9 will be libupm-grove.so, the python module pyupm_grove and the js module 10 jsupm_grove. 11 12 ### Choosing a name for a new module 13 14 1. Pick a name, typically the chip name is the most sensible 15 2. Use it & stick to it 16 17 ### Rules for name picking 18 19 1. Your lib must belong to the UPM namespace 20 2. Usually picking the name of the chip of your sensor/actuator makes sense. 21 Other times this does not. Try to pick a generic name so people with a similar 22 sensor can inherit your class if they only have minor changes. 23 3. Avoid brand names, often your module can be very generic with little effort 24 4. Use only lowercase characters in your file names and folder names. 25 26 ### Doubt 27 28 If ever, give either of us a ping via email: 29 mihai.tudor.panu (a] intel.com 30 john.r.van.drasek (a] intel.com 31 brendan.le.foll (a] intel.com 32 and we'll try suggest decent names for your module. 33 34
