How to add a Energenie USB power board?

[victorhooi]

Hi,

Does anybody know how to add a Energenie USB (EG-PM2S) power board?

This is on TerrariumPi 4.x - I see this screen:

but I'm not sure what to put in the Address, Name, Wattage or Water Flow fields?

Thanks,
Victor

[theyosh]

Hi,

sorry for the late response, but if you have a Energenie USB relay device connected, you could also use the 'scan relays' menu option. That should find all the relays.

If you have only 1 Energie USB device connected, which has 4 relays that can be controlled, you can just enter the value 1 till 4 as the address.

That also means that you have to add multiple relays in my software to control all the outlets of the device.

Per outlet, you can specify the amount of power in Watt that is used when toggled on, and the amount of water that is flowing in liter per minute.

The name is a free field, so enter something meaningful for you.

When manual mode is true, my software will not toggle the relay when it should based on the sensor state or timer state.

But you can get some more information by clicking on the question mark next to the title. That should show some extra information per field. For relays it is there, but not for all forms yet. I have to add some more help texts at the forms.

[victorhooi]

Thanks for the reply, theyosh@ =) (and a great project).

The exact model of my power board is Energenie EG-PMS2. (I believe this is just the surge-protected version of the normal EG-PM2).

I have connected this via USB cable to the Raspberry Pi 4.

Using lsusb, this shows up as a "Cypress Semiconductor Corp." device.

pi@raspberrypi:~ $ lsusb
Bus 002 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
Bus 001 Device 005: ID 04b4:fd15 Cypress Semiconductor Corp.
Bus 001 Device 002: ID 2109:3431 VIA Labs, Inc. Hub
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub

When I use "Scan relays" it does not pick up any new relays.

Is there some way to diagnose why this isn't being auto-detected, or troubleshoot the "Scan relays" function?

Here is the detailed information from lsusb -v for the board, by the way:

Bus 001 Device 005: ID 04b4:fd15 Cypress Semiconductor Corp.
Device Descriptor:
  bLength                18
  bDescriptorType         1
  bcdUSB               1.10
  bDeviceClass            0
  bDeviceSubClass         0
  bDeviceProtocol         0
  bMaxPacketSize0         8
  idVendor           0x04b4 Cypress Semiconductor Corp.
  idProduct          0xfd15
  bcdDevice            1.01
  iManufacturer           1 Gembird
  iProduct                2 EG-PMS2
  iSerial                 0
  bNumConfigurations      1
  Configuration Descriptor:
    bLength                 9
    bDescriptorType         2
    wTotalLength       0x001b
    bNumInterfaces          1
    bConfigurationValue     1
    iConfiguration          0
    bmAttributes         0x80
      (Bus Powered)
    MaxPower              150mA
    Interface Descriptor:
      bLength                 9
      bDescriptorType         4
      bInterfaceNumber        0
      bAlternateSetting       0
      bNumEndpoints           0
      bInterfaceClass         3 Human Interface Device
      bInterfaceSubClass      0
      bInterfaceProtocol      0
      iInterface              0
        HID Device Descriptor:
          bLength                 9
          bDescriptorType        33
          bcdHID               1.10
          bCountryCode            0 Not supported
          bNumDescriptors         1
          bDescriptorType        34 Report
          wDescriptorLength     217
          Report Descriptor: (length is 217)
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Local ): Usage, data= [ 0x06 ] 6
                            (null)
            Item(Main  ): Collection, data= [ 0x01 ] 1
                            Application
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x01 ] 1
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x20 ] 32
            Item(Global): Report Count, data= [ 0x01 ] 1
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x02 ] 2
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x01 ] 1
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x03 ] 3
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x01 ] 1
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x04 ] 4
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x72 ] 114
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x05 ] 5
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x05 ] 5
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x06 ] 6
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x01 ] 1
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x07 ] 7
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x72 ] 114
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x08 ] 8
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x05 ] 5
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x09 ] 9
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x01 ] 1
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x0a ] 10
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x72 ] 114
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x0b ] 11
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x05 ] 5
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x0c ] 12
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x01 ] 1
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x0d ] 13
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x72 ] 114
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): Collection, data= [ 0x03 ] 3
                            Report
            Item(Global): Usage Page, data= [ 0x84 ] 132
                            Power Device Page
            Item(Global): Report ID, data= [ 0x0e ] 14
            Item(Local ): Usage, data= [ 0x39 ] 57
                            (null)
            Item(Global): Report Size, data= [ 0x08 ] 8
            Item(Global): Report Count, data= [ 0x05 ] 5
            Item(Main  ): Feature, data= [ 0x02 ] 2
                            Data Variable Absolute No_Wrap Linear
                            Preferred_State No_Null_Position Non_Volatile Bitfield
            Item(Main  ): End Collection, data=none
            Item(Main  ): End Collection, data=none
Device Status:     0x0000
  (Bus Powered)

[theyosh]

Ah, your Energenie is to new :P .

The tool to control this relay is called sispmctl. That software package on the PI is to old to support your device. So you have to manually install a newer version of sispmctl: http://sispmctl.sourceforge.net/ (Go to 'Download & Installation' ). This should install a newer version of sispmctl on your PI. And my software should detect the new version after a restart. And then the auto scanning of relays should show 4 new relays.

[theyosh]

Also it needs libusb-dev package. So make sure you have installed that also: sudo apt install libusb-dev

[theyosh]

And you need to add a new file:

/etc/ld.so.conf.d/01-sispmctl.conf with the contents: /usr/local/lib

and then run : sudo ldconfig

[victorhooi]

Just a quick update here - was able to get it work - notes are below in case anybody else needs them.

@theyosh I have some follow up questions at the very bottom about configuration - would love to try to distil this, and contribute it to the docs =). Excited that I'm getting closer to getting this working!

I tried to check the existing version of sispmctl - however, this returned an error:

pi@raspberrypi:~ $ sispmctl -v
sispmctl: sispm_ctl.c:47: get_id: Assertion `dev!=0' failed.
Aborted

I'm not sure if this is a bug in the older version of sispmctl.

I was able to confirm it with apt though - the currently installed version was 3.1 (which according to the changelog - is from 2011?)

pi@raspberrypi:~ $ apt search sispmctl
Sorting... Done
Full Text Search... Done
sispmctl/stable,now 3.1-1 armhf [installed]
  Control Gembird SIS-PM programmable power outlet strips

I was able to follow theyosh@'s steps to install an updated version.

1. Install libusb-dev (sudo apt install libusb-dev).
2. Download the latest version (4.9) from Sourceforge.
3. Extract the tar.gz file.
4. Run ./configure, make, sudo make install
5. Add /usr/local/lib to /etc/ld.so.conf.d/01-sispmctl.conf.
6. Run sudo ldconfig

I do note at this point, sispmctl still didn't work right (I think it somehow was still the old version?) - I had to reboot the Raspberry Pi - and then it worked correctly:

pi@raspberrypi:~ $ sispmctl -v

SiS PM Control for Linux 4.9

(C) 2015-2020, Heinrich Schuchardt <xypron.glpk@gmx.de>
(C) 2011-2016, Pete Hildebrandt <send2ph@gmail.com>
(C) 2004-2011, Mondrian Nuessle
(C) 2005-2006, Andreas Neuper
(C) 2010, Olivier Matheret for the scheduling part

This program comes with ABSOLUTELY NO WARRANTY.

You may re-distribute it under the terms of the
GNU General Public License version 2 or later.
pi@raspberrypi:~ $ sispmctl -s
Gembird #0
USB information:  bus 001, device 003
device type:      4-socket SiS-PM
serial number:    01:01:4f:f3:ad

I was also able to run a scan from TerrariumPi, which found the relays now:

I did notice that the address seems to include both an outlet number (e.g. 1), and some kind of hexadecimal address (e.g. 01:01:4f:f3:ad):

Do you know what this hexadecimal address is? Is it critical? (e.g. if we add the board manually).

Finally - I'm still a bit confused about the "Manual mode" toggle - should we leave manual mode off, right?

If we turn manual mode on - then TerrariumPi will never toggle the state of the relay, right? What would be the use-case or purpose of turning manual mode on, in this case?

[theyosh]

The hex address is needed when you have more then 1 Energenie USB device. Else I do not know which device to use. If you have only 1 Energenie USB device, then the hex address is optional. So you could leave it out. But when I scan the hardware, I will add it.

This way, you can re-order the USB devices without loosing the right connection.

When you create areas where you can select relays to power things, my software will control the relay. That means that when you put it on and it should be off, it is powered off. And vise versa. When you put the relay in manual mode, my software will ignore the relay, and you can manually operate it. Some people wanted to make some extra external logic, which did not work well with my internal logic. And therefore, people can override (temporary) the relay with an API call.