Libs/LowLevelDevices

The user protocol devices library created to provide access to device's data of low-level buses, with protocols simple enough to implement into the User Protocol module or directly on the internal like to Java language.

The template's names and their parameters are available in languages: English, Ukrainian and mRussian. Their source code wrote in the human-language independent mode with calls for the translations by the function tr() and the message's translation also allowed for English, Ukrainian and mRussian.

For connection the library to a project of the OpenSCADA station you can obtain the database file as:

• supplied with a ready and proper package of the Linux distribution like to "openscada-libdb-main", "openscada-LibDB.Main";
• directly taken for most actual one from the subversion repository and converted to the DB SQLite file in the way:

wget http://oscada.org/svn/trunk/OpenSCADA/data/LibsDB/OscadaLibs.sql
sqlite3 -init OscadaLibs.sql OscadaLibs.db .exit

• downloaded for the one attached here.

This obtained file next you can place into the project directory of the station and create the database object for the DB module "SQLite", registering the database file in the configuration.

For the DAQ-templates in generic you need to create a representing object of the device into the Logical controller module and to select the proper template from the templates library. Next, to correct configuration, follow to specific of the template into its individual description. The conception of accessing the data by a user protocol we can imagine like to Figure 1.

Fig.1. Conception of user accessing to services and device's data.

As you can see from Figure 1, interaction with devices carried out through some transport on which their physically based. Requests to the transport you can send:

1. Directly by OpenSCADA system API function of the transport object string messIO( string mess, real timeOut = 0 );, if the protocol specific part is very simple and you need only the data extract.
2. Wrapped data request req by function int messIO( XMLNodeObj req, string prt ); and for protocol prt, if the protocol part is complex enough and already presented in OpenSCADA.
3. Wrapped data request specific for user by function int messIO( XMLNodeObj req, "UserProtocol" ); and the user protocol implementation, if the protocol part is complex enough and not yet present in OpenSCADA. The user implements here itself of the protocol specific part in the module UserProtocol and the data specific part in the template for the Logical Level module or directly in controller's procedure on the internal language of the module JavaLikeCalc.

This latter method is currently developed to the possibility of forming a protocol code part directly in the same code of the template as a separate built-in function with call the requesting function of the first method, if there is no need for reuse, or even if such a need exists and it makes sense to create a complex template that can combine the role of the output protocol, through its connection to the user protocol module. And it will be completely stored in a single template library.

Working directly with the output transport of the string messIO(string mess, real timeOut = 0); function does not imply blocking the output transport outside this function call and, therefore, for complex protocols with response packets more than in one packet, which requires the "waiting" process, can not be used a shared transport, at which can be sent packets of different protocols or even one, but for different tasks (controller objects). Therefore, if you need to use shared transport, place the poll parameters in one controller object (task), or use the user protocol module to which this remark is irrelevant, since it performs such blocking at the time of the call of the processing procedure, as well as other modular protocols of OpenSCADA. To place a protocol implementation here you need to do and to follow for the shown demands:

• be the copyright holder or the author of the code and distribute it under any free license, GPL preferred;
• prepare and store into a separated DB file of SQLite, or as a text file, for: the parameters (IO) description, the procedure's code wrote and formed in some system way;
• write a short description and instruction for connect a device by the protocol in way like to the other ones here;
• write a direct request to the forum topic "OpenSCADA development" for placing the protocol here, include a proving of its ability to work from any OpenSCADA developer or a short demonstration video.

RDTech UM24C/UM25C/UM34C BlueTooth interface template. Tested only on UM24C now.

The RDTech (RuiDeng) UM24C, UM25C and UM34C are low-cost USB pass-through power measurement devices, and support a decent number of collection features, as well as full control via Bluetooth. This template implements most exposed commands and data collection available by the device's Bluetooth interface.

This template in first time uses the new output transports connection function SYS.Transport.outAt() and the Bluetooth interface for the data acquisition.

• Total complexity: 0.3 HD^[!]
• Thanks: for Ryan Finnie at the protocol initial processing in RDUMTOOL

Template IOs

Configuring and using

1. Connection the BlueTooth device:

bluetoothctl
#[bluetooth]# scan on
#  Discovery started
#  [NEW] Device 98:D3:31:F8:52:29 UM24C
#  [CHG] Device 98:D3:31:F8:52:29 RSSI: -60
#[bluetooth]# scan off
#[bluetooth]# pair 98:D3:31:F8:52:29
#  Attempting to pair with 98:D3:31:F8:52:29
#  [CHG] Device 98:D3:31:F8:52:29 Connected: yes
#  Request PIN code
#  [UM241m[agent] Enter PIN code: 1234
#  Pairing successful
#[bluetooth]# trust 98:D3:31:F8:52:29
#  [CHG] Device 98:D3:31:F8:52:29 Trusted: yes
#  Changing 98:D3:31:F8:52:29 trust succeeded
#[bluetooth]# exit

rfcomm bind 0 98:D3:31:F8:52:29   # 0 here for binding to /dev/rfcomm0

2. Create and start a logical controller object or use any presented one with the needed scheduling properties.

3. Create a logical parameter object and select this template for it, one for each the devices. Enable the parameter.

4. Into the tab "Template configuration" of the logical parameter object you need to set:

• Transport — to the address of the automatically created transport with its parameters after ":", according to the function SYS.Transport.outAt() address format, where the device address corresponds to the command rfcomm bind 0 in item 1.
• Device to bind — here you may set the Bluetooth address of the device as "98:D3:31:F8:52:29" to call the rfcomm bind {N} command when starting the template, where N is respectively taken from the address of the previous item.

The rfcomm command is normally not available to be called by a non-privileged user, and if you want to call it by such a user, you must set a corresponding sign for it as chmod u+s /usr/bin/rfcomm from the super user.

5. RESULT: The logical parameter object will perform gather data of and trace to modify of the writable properties.

ATORCH UC96, UD24 BlueTooth interface template.

The ATORCH UC96, UD24 are low-cost USB pass-through power measurement device with many interfaces and supporting a decent number of collection features, as well as control via Bluetooth. This template implements only the clearing data command and data collection by the device's Bluetooth interface.

The device sends data packages not at a request and just after establishing the connection, that is broadcasting with one second period. The device may not to send the data packages at enable not in the first screen, so you need to switch the first screen for the data appearance. The data can be missed also after suspending the PC, so this template in the first time implements the data missing detection and reconnection.

• Total complexity: 0.3 HD^[!]

Template IOs

Configuring and using

1. Connection the BlueTooth device: performed in the standard way of pairing and trusting without PIN and to UC96_SPP

2. Create and start a logical controller object or use any presented one with the needed scheduling properties.

3. Create a logical parameter object and select this template for it, one for each the devices. Enable the parameter.

4. Into the tab "Template configuration" of the logical parameter object you need to set:

• Transport — to the address of the automatically created transport with its parameters after ":", according to the function SYS.Transport.outAt() address format, where the device address corresponds to the command rfcomm bind 0.
• Device to bind — here you may set the Bluetooth address of the device as "58:F4:04:33:D5:FD" to call the rfcomm bind {N} command when starting the template, where N is respectively taken from the address of the previous item.

The rfcomm command is normally not available to be called by a non-privileged user, and if you want to call it by such a user, you must set a corresponding sign for it as chmod u+s /usr/bin/rfcomm from the super user.

• No data detection time — here you may set the time of detection of the data missing.

5. RESULT: The logical parameter object will perform gather data of and trace to modify of the writable properties.

One Wire sensors bus implementing by 1Wire-adapter {DS9097,DS9097U}. Supported direct and parasite powering for the temperature sensors.
Supported 1Wire-devices: DS1820, DS1820/DS18S20/DS1920 (not tested), DS1822 (not tested), DS2413, DS2408, DS2450, DS2438.

Template IOs

Configuring and using

1. Create an output transport of the type "Serial" and set its Identifier like to "oneWire", one for each the One Wire bus.

2. Set proper address of the Serial device, only for the adapter's serial device like "/dev/ttyS{N}". The serial port speed, asynchronous data format and timeouts will adjust by the template.

3. Create and start a logical controller object or use any presented one with the needed scheduling properties.

4. Create a logical parameter object and select the template for that, one for each the devices. Enable the parameter.

5. Into the tab "Template configuration" of the logical parameter object you need to set:

• Transport of the One Wire bus, Serial — to the address of the transport into step 1. Tracing for the address changing is supported.
• Rescan period, s — periodicity of rescaning for new and removed devices search.

6. RESULT: The logical parameter object will perform at first searching to 1Wire devices on the bus and create included parameters to the each found one. Next the logical parameter object will perform gather data of the found devices and trace to modify of the writable device's properties.

I2C 8-bit 4xA/D and D/A converter. Connects through a Serial output transport into the I2C mode.

Template IOs

Configuring and using

1. Create an output transport of the type "Serial" and set its Identifier like to "i2c", one for each the I2C bus.

2. Set proper address of the Serial device, only the I2C bus address like "/dev/i2c-{N}". Set the symbol's time into the timeouts field to the minimum value.

3. Create and start a logical controller object or use any presented one with the needed scheduling properties.

4. Create a logical parameter object and select the template for that, one for each I2C slave devices. Enable the parameter.

5. Into the tab "Template configuration" of the logical parameter object you need to set:

• transport — to the address of the transport into step 1. Tracing for the address changing is supported.
• addr — the I2C slave device's address [0...119].
• vRef — reference voltage of the AIs and AO.

6. RESULT: The logical parameter object will perform interaction and placing of gathered data to the AI attributes and also will take the AO and write to the chip.

I2C 8-bit 8DIO. Connects through a Serial output transport into the I2C mode.

Template IOs

Configuring and using

1. Create an output transport of the type "Serial" and set its Identifier like to "i2c", one for each the I2C bus.

2. Set proper address of the Serial device, only the I2C bus address like "/dev/i2c-{N}". Set the symbol's time into the timeouts field to the minimum value.

3. Create and start a logical controller object or use any presented one with the needed scheduling properties.

4. Create a logical parameter object and select the template for that, one for each I2C slave devices. Enable the parameter.

5. Into the tab "Template configuration" of the logical parameter object you need to set:

• transport — to the address of the transport into step 1. Tracing for the address changing is supported.
• addr — the I2C slave device's address [0...119].

6. RESULT: The logical parameter object will perform interaction and placing of gathered data to the DI attributes and also will take the DO and write to the chip.

I2C 12/16-bit 4xA/D converter. Connect through a Serial output transport into the I2C mode.

Template IOs

Configuring and using

1. Create an output transport of the type "Serial" and set its Identifier like to "i2c", one for each the I2C bus.

2. Set proper address of the Serial device, only the I2C bus address like "/dev/i2c-{N}". Set the symbol's time into the timeouts field to the minimum value.

3. Create and start a logical controller object or use any presented one with the needed scheduling properties.

4. Create a logical parameter object and select the template for that, one for each I2C slave devices. Enable the parameter.

5. Into the tab "Template configuration" of the logical parameter object you need to set:

• transport — to the address of the transport into step 1. Tracing for the address changing is supported.
• addr — the I2C slave device's address [0...119].
• range — range of voltage of the AIs.

6. RESULT: The logical parameter object will perform interaction and placing of gathered data to the AI attributes.

I2C 12-bit D/A converter. Connect through a Serial output transport into the I2C mode.

Template IOs

Configuring and using

1. Create an output transport of the type "Serial" and set its Identifier like to "i2c", one for each the I2C bus.

2. Set proper address of the Serial device, only the I2C bus address like "/dev/i2c-{N}". Set the symbol's time into the timeouts field to the minimum value.

3. Create and start a logical controller object or use any presented one with the needed scheduling properties.

4. Create a logical parameter object and select the template for that, one for each I2C slave devices. Enable the parameter.

5. Into the tab "Template configuration" of the logical parameter object you need to set:

• transport — to the address of the transport into step 1. Tracing for the address changing is supported.
• addr — the I2C slave device's address [0...119].
• vRef — reference voltage of the AO.

6. RESULT: The logical parameter object will perform interaction and take the AO and write to the chip.

I2C Pressure and Temperature sensor. Connecting through a Serial output transport into the I2C mode.

Template IOs

Configuring and using

1. Create an output transport of the type "Serial" and set its Identifier like to "i2c", one for each the I2C bus.

2. Set proper address of the Serial device, only the I2C bus address like "/dev/i2c-{N}". Set the symbol's time into the timeouts field to the minimum value.

3. Create and start a logical controller object or use any presented one with the needed scheduling properties.

4. Create a logical parameter object and select the template for that, one for each I2C slave devices. Enable the parameter.

5. Into the tab "Template configuration" of the logical parameter object you need to set:

• transport — to the address of the transport into step 1. Tracing for the address changing is supported.
• addr — the I2C slave device's address [0...119].
• oss — oversampling setting of pressure measurement [0...3].

6. RESULT: The logical parameter object will perform interaction and placing of gathered data to the Pressure and Temperature attributes.

I2C Barometric Pressure, Temperature and Humidity sensor. Connect through a Serial output transport into the I2C mode.

Template IOs

Configuring and using

1. Create an output transport of the type "Serial" and set its Identifier like to "i2c", one for each the I2C bus.

2. Set proper address of the Serial device, only the I2C bus address like "/dev/i2c-{N}". Set the symbol's time into the timeouts field to the minimum value.

3. Create and start a logical controller object or use any presented one with the needed scheduling properties.

4. Create a logical parameter object and select the template for that, one for each I2C slave devices. Enable the parameter.

5. Into the tab "Template configuration" of the logical parameter object you need to set:

• transport — to the address of the transport into step 1. Tracing for the address changing is supported.
• addr — the I2C slave device's address [0...119].
• oss — oversampling setting of pressure measurement [0...7].

6. RESULT: The logical parameter object will perform interaction and placing of gathered data to the Pressure, Temperature and Humidity attributes.

Digital Temperature and Humidity Sensor for the models: SHT30

Template IOs

Configuring and using

1. Create an output transport of the type "Serial" and set its Identifier like to "i2c", one for each the I2C bus.

2. Set proper address of the Serial device, only the I2C bus address like "/dev/i2c-{N}". Set the symbol's time into the timeouts field to the minimum value.

3. Create and start a logical controller object or use any presented one with the needed scheduling properties.

4. Create a logical parameter object and select the template for that, one for each I2C slave devices. Enable the parameter.

5. Into the tab "Template configuration" of the logical parameter object you need to set:

• transport — to the address of the transport into step 1. Tracing for the address changing is supported;
• addr — the I2C slave device's address [0...119].

6. RESULT: The logical parameter object will perform interaction and placing of gathered data to the Temperature and Humidity attributes.

I2C RTC chips DS1307,DS3231 with Temperature sensor and calibration for DS3231. Connects through a Serial output transport into the I2C mode.

Template IOs

Configuring and using

1. Create an output transport of the type "Serial" and set its Identifier like to "i2c", one for each the I2C bus.

2. Set proper address of the Serial device, only the I2C bus address like "/dev/i2c-{N}". Set the symbol's time into the timeouts field to the minimum value.

3. Create and start a logical controller object or use any presented one with the needed scheduling properties.

4. Create a logical parameter object and select the template for that, one for each I2C slave devices. Enable the parameter.

5. Into the tab "Template configuration" of the logical parameter object you need to set:

• transport — to the address of the transport into step 1. Tracing for the address changing is supported.
• addr — the I2C slave device's address [0...119].

6. RESULT: The logical parameter object will perform interaction and placing of gathered data to the DateTime, Temperature and some one state attributes and also will take the DateTime, some one state attributes and write it to the chip.

Provides operations with EEPROM memory based on I2C chips AT24C32 (4KB) and AT24C64 (8KB). Supported random reading and writing.

Output user protocol's XML request structure
<{cmd} addr="{ChipAddr}" off="{MemOffset}" size="{ReadSize}" err="1:Error">{ReadWriteSeq}</{cmd}>

cmd — command, for now there allowed: "read", "write";

addr — I2C device address [0...119];

off — memory part offset;

size — read memory block size.

ReadWriteSeq — Read/Write bytes sequence.

err — sets to result of the request.

Configuring and using

1. Create an output transport of the type "Serial" and set its Identifier like to "i2c", one for each the I2C bus.

2. Set proper address of the Serial device, only the I2C bus address like "/dev/i2c-{N}". Set the symbol's time into the timeouts field to the minimum value.

3. Place some requesting commands directly into presented or a new internal OpenSCADA procedure like to:

req = SYS.XMLNode("read"); req.setAttr("ProtIt","AT24CXX").setAttr("addr",87).setAttr("off",1000).setAttr("size",20).setText("My message");
req = SYS.XMLNode("write"); req.setAttr("ProtIt","AT24CXX").setAttr("addr",87).setAttr("off",1000).setText("Stored data");

4. RESULT: Into text() for "read" you will get the read data if no errors occur.

Digital Temperature and Humidity Sensor for models: DHT11, DHT12, AM2302, AM2320, ... . The module designed for the sensors connect through GPIO, mostly it's Raspberry PI BCM2835 GPIO.
Conditions: Exclusively realtime planing in the priority 199 (FIFO-99).

Template IOs

Configuring and using

1. Create an output controller object and a parameter into the DAQ module "BCM 2835", by default it's "pi.pi".

2. Create and start a logical controller object or use any presented one with the needed scheduling properties (FIFO-199).

3. Create a logical parameter and select the template for that, one for each sensor. Enable the parameter.

4. Into the tab "Template configuration" of the logical parameter object you need to set:

• addr — to the address of the "BCM 2835" parameter like "DAQ.GPIO.io.pi"; tracing for the address changing is supported;
• pin — GPIO pin number where connected the data pin of the sensor;
• tries — tries of the sensor reading;
• dev — generic device specific selection.

5. RESULT: The logical parameter will perform interaction and placing of the gathered data to the Temperature and Humidity attributes.

Cold-Junction-Compensated K-Thermocouple-to-Digital Converter (0°C to +1024°C). The module designed for the sensors connect through softSPI by GPIO, mostly it's Raspberry PI BCM2835 GPIO.
Conditions: Exclusively realtime planing in the priority 199 (FIFO-99).

Template IOs

Configuring and using

1. Create an output controller object and a parameter into the DAQ module "BCM 2835", by default it's "pi.pi".

2. Create and start a logical controller object or use any presented one with the needed scheduling properties (FIFO-199).

3. Create a logical parameter and select the template for that, one for each sensor. Enable the parameter.

4. Into the tab "Template configuration" of the logical parameter object you need to set:

• addr — to the address of the "BCM 2835" parameter like "DAQ.GPIO.io.pi"; tracing for the address changing is supported;
• pin_cs — CS pin number where connected the chip selection pin of the sensor;
• pin_sclk — SCLK pin number where connected the serial clock pin of the sensor;
• pin_miso — MISO pin number where connected the master in slave out (data) pin of the sensor.

5. RESULT: The logical parameter will perform interaction and placing of the gathered data to the Temperature attributes.

LCD Module 1602A, STN, BLUB, 16 Character x 2 Line, 5 x 8 Dots, by the direct (Raspberry PI BCM2835 GPIO) or I2C (PCF8574) wiring.
Conditions: Default planing policy but realtime one preferred.

Template IOs

Configuring and using

1. Create an output controller and an object of parameter in DAQ module "BCM 2835", by default it's "pi.pi" or create an output transport of the type "Serial", set address like to "i2c", one for each the I2C bus.

2. Create and start a logical controller object or use any presented one with the needed scheduling properties.

3. Create a logical parameter object and select the template for that, one for each sensor. Enable the parameter.

4. Into the tab "Template configuration" of the logical parameter object you need to set:

• transport — to address of the "BCM 2835" parameter like to "DAQ.GPIO.io.pi" or to address of the transport into step 1; tracing for the address changing is supported;
• addr — the I2C slave device's address [0...119];
• RS, E, D4, D5, D6, D7 — numbers of the GPIO pins where connected the proper data ones of the sensor.

5. RESULT: The logical parameter object will perform interaction and setting lines' values to the display.