Allow accessing subdevices by specifying subdevice id as slave.subdevice (volkszaehler#138)

Author: andig

README.md

@@ -290,12 +290,16 @@ are supported, too. SunSpec defines a default register layout for accessing
 the devices.
 
 Supported inverters include popular devices from SolarEdge (SE3000, SE9000)
-and SMA (Sunny Boy and Sunny Tripower).
+and SMA (Sunny Boy and Sunny TriPower).
 
-In case of TCP connection, the adapter paramter becomes the hostname and port:
+In case of TCP connection, the adapter parameter becomes the hostname and port:
 
 	./mbmd run -a 192.168.0.44:502 -d SMA:23
 
+SunSpec devices can host multiple subdevices, e.g. to expose a meter attached to an inverter. To access a subdevice, append its id to the slave id:
+
+	./mbmd run -a 192.168.0.44:502 -d FRONIUS:1.0 -d FRONIUS:1.1
+
 
 # Changelog
 

assets/index.html

@@ -41,7 +41,7 @@
 		<div id="realtime">
 			<h1>Measurements</h1>
 			<p>${ message }</p>
-			<table class="metertable table table-striped" v-for="(m, idx) in sortedMeters">
+			<table class="metertable table table-striped" v-for="(m, idx) in sorted(meters)">
 				<thead class="thead-dark">
 					<tr class="d-flex">
 						<th class="col-3">${ idx }</th>
@@ -394,7 +394,7 @@ <h1>Status</h1>
 					</tr>
 				</thead>
 				<tbody>
-					<tr v-for="(m, idx) in meters">
+					<tr v-for="(m, idx) in sorted(meters)">
 						<td>${ idx }</td>
 						<td>${ m.Type }</td>
 						<td>${ m.Status }</td>

assets/js/app.js

@@ -1,24 +1,27 @@
+let sort = {
+	methods: {
+		sorted: function(theMap) {
+			var devs = Object.keys(theMap);
+			devs.sort();
+			var res = {};
+			devs.forEach(function (key) {
+				res[key] = theMap[key];
+			});
+			return res;
+		}
+	}
+}
+
 var dataapp = new Vue({
 	el: '#realtime',
 	delimiters: ['${', '}'],
+	mixins: [sort],
 	data: {
 		meters: {},
 		message: 'Loading...'
 	},
-	computed: {
-		// return meters sorted by name
-		sortedMeters: function() {
-			var devs = Object.keys(this.meters);
-			devs.sort();
-			var res = {};
-			devs.forEach(function(key) {
-				res[key] = this.meters[key];
-			}, this);
-			return res;
-		}
-	},
 	methods: {
-		// pop returns true if it was called with any non-null argumnt
+		// pop returns true if it was called with any non-null argument
 		pop: function () {
 			for(var i=0; i<arguments.length; i++) {
 				if (arguments[i] !== undefined && arguments[i] !== null && arguments[i] !== "") {
@@ -48,6 +51,7 @@ var timeapp = new Vue({
 var statusapp = new Vue({
 	el: '#status',
 	delimiters: ['${', '}'],
+	mixins: [sort],
 	data: {
 		meters: {}
 	}
@@ -131,11 +135,9 @@ function connectSocket() {
 	ws = new WebSocket(protocol + "//" + loc.hostname + (loc.port ? ":" + loc.port : "") + "/ws");
 
 	ws.onerror = function(evt) {
-		// console.warn("Connection error");
 		ws.close();
 	}
 	ws.onclose = function (evt) {
-		// console.warn("Connection closed");
 		window.setTimeout(connectSocket, 100);
 	};
 	ws.onmessage = function (evt) {

cmd/commons.go

@@ -61,19 +61,20 @@ func meterHelp() string {
 }
 
 // countDevices counts all devices for all meters
-func countDevices(managers map[string]meters.Manager) int {
+func countDevices(managers map[string]*meters.Manager) int {
 	var count int
 	for _, m := range managers {
 		m.All(func(id uint8, dev meters.Device) {
-			log.Printf("config: declared device %s:%d", dev.Descriptor().Manufacturer, id)
+			conf := dev.Descriptor()
+			log.Printf("config: declared device %s:%d.%d", conf.Type, id, conf.SubDevice)
 			count++
 		})
 	}
 	return count
 }
 
 // setLogger enabled raw logging for all devices
-func setLogger(managers map[string]meters.Manager, logger meters.Logger) {
+func setLogger(managers map[string]*meters.Manager, logger meters.Logger) {
 	for _, m := range managers {
 		m.Conn.Logger(logger)
 	}

cmd/confighandler.go

@@ -83,22 +83,23 @@ type AdapterConfig struct {
 
 // DeviceConfig describes a single device's configuration
 type DeviceConfig struct {
-	Type    string
-	ID      uint8
-	Name    string
-	Adapter string
+	Type      string
+	ID        uint8
+	SubDevice int
+	Name      string
+	Adapter   string
 }
 
 // DeviceConfigHandler creates map of meter managers from given configuration
 type DeviceConfigHandler struct {
 	DefaultDevice string
-	Managers      map[string]meters.Manager
+	Managers      map[string]*meters.Manager
 }
 
 // NewDeviceConfigHandler creates a configuration handler
 func NewDeviceConfigHandler() *DeviceConfigHandler {
 	conf := &DeviceConfigHandler{
-		Managers: make(map[string]meters.Manager),
+		Managers: make(map[string]*meters.Manager),
 	}
 	return conf
 }
@@ -130,7 +131,7 @@ func createConnection(device string, rtu bool, baudrate int, comset string) (res
 }
 
 // ConnectionManager returns connection manager from cache or creates new connection wrapped by manager
-func (conf *DeviceConfigHandler) ConnectionManager(connSpec string, rtu bool, baudrate int, comset string) meters.Manager {
+func (conf *DeviceConfigHandler) ConnectionManager(connSpec string, rtu bool, baudrate int, comset string) *meters.Manager {
 	manager, ok := conf.Managers[connSpec]
 	if !ok {
 		conn := createConnection(connSpec, rtu, baudrate, comset)
@@ -142,8 +143,9 @@ func (conf *DeviceConfigHandler) ConnectionManager(connSpec string, rtu bool, ba
 }
 
 func (conf *DeviceConfigHandler) createDeviceForManager(
-	manager meters.Manager,
+	manager *meters.Manager,
 	meterType string,
+	subdevice int,
 ) meters.Device {
 	var meter meters.Device
 	meterType = strings.ToUpper(meterType)
@@ -159,8 +161,12 @@ func (conf *DeviceConfigHandler) createDeviceForManager(
 
 	sort.SearchStrings(sunspecTypes, meterType)
 	if isSunspec {
-		meter = sunspec.NewDevice(meterType)
+		meter = sunspec.NewDevice(meterType, subdevice)
 	} else {
+		if subdevice > 0 {
+			log.Fatalf("Invalid subdevice number for device %s: %d", meterType, subdevice)
+		}
+
 		var err error
 		meter, err = rs485.NewDevice(meterType)
 		if err != nil {
@@ -189,7 +195,7 @@ func (conf *DeviceConfigHandler) CreateDevice(devConf DeviceConfig) {
 	if !ok {
 		log.Fatalf("Missing adapter configuration for device %v", devConf)
 	}
-	meter := conf.createDeviceForManager(manager, devConf.Type)
+	meter := conf.createDeviceForManager(manager, devConf.Type, devConf.SubDevice)
 
 	if err := manager.Add(devConf.ID, meter); err != nil {
 		log.Fatalf("Error adding device %v: %v.", devConf, err)
@@ -224,7 +230,19 @@ func (conf *DeviceConfigHandler) CreateDeviceFromSpec(deviceDef string) {
 		log.Fatalf("Cannot parse device definition- meter type empty: %s. See -h for help.", meterDef)
 	}
 
-	id, err := strconv.Atoi(devID)
+	var subdevice int
+	devIDSplit := strings.SplitN(devID, ".", 2)
+	if len(devIDSplit) == 2 {
+		var err error
+		subdevice, err = strconv.Atoi(devIDSplit[1])
+		if err != nil {
+			log.Fatalf("Error parsing device id %s: %v. See -h for help.", devID, err)
+		}
+	} else if len(devIDSplit) > 2 {
+		log.Fatalf("Error parsing device id %s. See -h for help.", devID)
+	}
+
+	id, err := strconv.Atoi(devIDSplit[0])
 	if err != nil {
 		log.Fatalf("Error parsing device id %s: %v. See -h for help.", devID, err)
 	}
@@ -233,7 +251,7 @@ func (conf *DeviceConfigHandler) CreateDeviceFromSpec(deviceDef string) {
 	// have been created of the --rtu flag was specified. We'll not re-check this here.
 	manager := conf.ConnectionManager(connSpec, false, 0, "")
 
-	meter := conf.createDeviceForManager(manager, meterType)
+	meter := conf.createDeviceForManager(manager, meterType, subdevice)
 	if err := manager.Add(uint8(id), meter); err != nil {
 		log.Fatalf("Error adding device %s: %v. See -h for help.", meterDef, err)
 	}

cmd/scan.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"errors"
 	"fmt"
 	golog "log"
 	"os"
@@ -97,15 +98,15 @@ func scan(cmd *cobra.Command, args []string) {
 	v := validator{[]float64{110, 230}}
 
 SCAN:
-	// loop over all valid slave adresses
+	// loop over all valid slave addresses
 	for deviceID := 1; deviceID <= 247; deviceID++ {
 		// give the bus some time to recover before querying the next device
 		time.Sleep(40 * time.Millisecond)
 		conn.Slave(uint8(deviceID))
 
 		for _, dev := range devices {
 			if err := dev.Initialize(client); err != nil {
-				if _, partial := err.(meters.SunSpecPartiallyInitialized); !partial {
+				if !errors.Is(err, meters.ErrPartiallyOpened) {
 					continue // devices
 				}
 				log.Println(err) // log error but continue

mbmd.dist.yaml

@@ -40,4 +40,5 @@ devices:
 - name: sma1
   type: sunspec
   id: 126
+  subdevice: 0 # use subdevice to access SunSpec subdevices
   adapter: 192.168.0.40:502

meters/device.go

@@ -4,19 +4,15 @@ import (
 	"github.com/grid-x/modbus"
 )
 
-// SunSpecPartiallyInitialized indicates error during device initialization.
-// The sunspec device's model tree may be incomplete.
-type SunSpecPartiallyInitialized interface {
-	PartiallyInitialized()
-}
-
 // DeviceDescriptor describes a device
 type DeviceDescriptor struct {
+	Type         string
 	Manufacturer string
 	Model        string
 	Options      string
 	Version      string
 	Serial       string
+	SubDevice    int
 }
 
 // Device is a modbus device that can be described, probed and queried

meters/errors.go

@@ -2,5 +2,10 @@ package meters
 
 import "errors"
 
-// ErrNaN indicates a NaN reading result
-var ErrNaN = errors.New("NaN value")
+var (
+	// ErrNaN indicates a NaN reading result
+	ErrNaN = errors.New("NaN value")
+
+	// ErrPartiallyOpened indicates a partially opened device
+	ErrPartiallyOpened = errors.New("Device partially opened")
+)

meters/manager.go

@@ -1,31 +1,33 @@
 package meters
 
-import (
-	"fmt"
-)
+type device struct {
+	id  uint8
+	dev Device
+}
 
 // Manager handles devices attached to a connection
 type Manager struct {
-	devices map[uint8]Device
+	devices []device
 	Conn    Connection
 }
 
 // NewManager creates a new connection manager instance. connection managers operate devices on a connection instance
-func NewManager(conn Connection) Manager {
+func NewManager(conn Connection) *Manager {
 	m := Manager{
-		devices: make(map[uint8]Device, 1),
+		devices: make([]device, 0),
 		Conn:    conn,
 	}
-	return m
+	return &m
 }
 
 // Add adds device to the device manager at specified device id
-func (m *Manager) Add(id uint8, device Device) error {
-	if _, ok := m.devices[id]; ok {
-		return fmt.Errorf("duplicate device id %d", id)
+func (m *Manager) Add(id uint8, dev Device) error {
+	device := device{
+		id:  id,
+		dev: dev,
 	}
 
-	m.devices[id] = device
+	m.devices = append(m.devices, device)
 	return nil
 }
 
@@ -35,9 +37,18 @@ func (m *Manager) Count() int {
 }
 
 // All iterates over all devices and executes the callback per device.
-// Before the callback, the slave id is set on the underlying connection if access is true.
 func (m *Manager) All(cb func(uint8, Device)) {
-	for id, device := range m.devices {
-		cb(id, device)
+	for _, device := range m.devices {
+		cb(device.id, device.dev)
+	}
+}
+
+// Find iterates over devices and executes the callback per device until true is returned.
+func (m *Manager) Find(cb func(uint8, Device) bool) bool {
+	for _, device := range m.devices {
+		if cb(device.id, device.dev) {
+			return true
+		}
 	}
+	return false
 }