Cube 350 Energy meter

This library allows you to communicate to a Northern Design Cube 350 Smart meter through two-wired modbus (RS485)

Travis build status

Master:
Development:

Getting Started (Hardware)

These instructions will allows you to get the library up and running on your local machine.

Prerequisites

* A minimum of Java 8 is required for this library.
* If running on Linux, you will need to add your user to the dialout group.

Required hardware

* Cheap CH340 USB to RS485 converter (about 1.5$) or other variants
* Cube 350 Kwh meter or other variants

Serial port user [Linux]

To able to access the serial port, you need to add your user that you want to run this library to the dialout group.
This will add your current user to the dialout group.

sudo adduser $USER dialout

Set the slave ID, Baudrate & other things like CT for your cube 350

(See Section 4. Programming of the Cube350 A4 Operating Manual July 2006 A4.pdf)

(SW) properties are required as input parameters for this library.

Quick summary:

• Go into programming mode (See Section 4. Programming of the Cube350 A4 Operating Manual July 2006 A4.pdf)
• Press I & V together for 5 seconds.

  Depending you have set a security code through Modbus or the programming menu, you will or will not have to provide a code.

• Press I to go to another property.
• (SW) CT -> Set the current of your attached 0.33mV CT (50A, 100A, 200A, 800A, …)
• Un (Nominal Line-Line Voltage) ~ Most is 400V (I needed to tweak mine to 390V)
• Plr, Plt, Pto is depending on the Pulse which is the two external hardware pulse outputs
• (SW) Br -> Baud rate (Support 4800, 9600 & 19200)
• (SW) Addr -> Modbus Slave ID. This ID also needs to be used in the software.
• Saving to flash & ready to use.

Getting Started (Library)

How to use

You can use this library to read out one or multiple Cube 350 Modbus energy meter(s).
Through readEnergyModbusRegister() it is possible to directly access the Modbus registers.
It is also possible to read out the calculated energy value through CombinedEnergyRegister.
This gives you a correct result like Kwh, Kvarh & many more values.

This library has been written with simplicity in mind meaning you are in full control of threads, schedulers, …

Example (One Cube)

import static com.github.mdevloo.cube.modbus.register.energy.energy.CombinedEnergyRegister.KWH;
final class Application {
    void cubeReadout() {
            final int id = 5;
            final ModbusConfiguration modbusConfiguration = new ModbusSerialConfiguration("/dev/ttyUSB0",
                    ModbusCommunication.BaudRate.RATE_9600, 10);
            final CubeMeter cubeMeter = new CubeMeter.Builder(id, modbusConfiguration)
                    .registers(InstantaneousModbusRegister.values())
                    .combinedRegisters(KWH)
                    .build();
            final ModbusService cubeModbusService = new CubeModbusService(cubeMeter);
            final List<CombinedModbusResult> cubeEnergyvalue = cubeModbusService.readEnergyModbusRegister(CubeModbusService.Scaler.KWH);
            cubeEnergyvalue.forEach(res -> logger.info("Register {} - Energy value :{} KwH", res.getCombinedRegister(), res.calculateEnergyScaling()));
            final List<ModbusResult> modbusResults = cubeModbusService.readModbusRegisters();
            modbusResults.forEach(mod -> logger.info("Value of Register: {} - {}", mod.getModbusRegister(), mod.getRegister().getValue()));
        }
}

Exceptions

[pool-1-thread-1] ERROR com.github.mdevloo.cube.modbus.service.CubeModbusService - Modbus communication error: [Modbus connection exception: [Port [ttyUSB0] cannot be opened or does not exist - Valid ports are: [ttyUSB0]]]

• Add your user to the dialout group. See: Serial port user [Linux]
• It is also possible that your cube has the wrong Slave ID. See: How to set your Slave ID for your Cube 350

License

This project is licensed under the MIT License - see the LICENSE file for details