More comments, small improvements

README.md

@@ -29,7 +29,7 @@ This client currently implements a [`MediaPlayer` entity](https://github.com/unf
 
 Run with `ucrt deconz`
 
-This client currently implements [`Light` entities](https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_light.md) for discovered DeCONZ Lights and [`Sensor` entitites](https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_sensor.md) for selected DeCONZ sensors.
+This client currently implements [`Light` entities](https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_light.md) for discovered DeCONZ Lights and Groups and [`Sensor` entitites](https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/entity_sensor.md) for selected DeCONZ sensors.
 
 ## How to use
 

pkg/client/client.go

@@ -21,7 +21,7 @@ type Client struct {
 	// Here you can add entities if they are already known
 	initFunc func()
 	// Called by RemoteTwo when the integration is added and setup started
-	setupFunc func()
+	setupFunc func(integration.SetupData)
 	// Handles connect/disconnect calls from RemoteTwo
 	clientLoopFunc        func()
 	setDriverUserDataFunc func(map[string]string, bool)
@@ -87,7 +87,7 @@ func (c *Client) HandleConnection(e *integration.ConnectEvent) {
 func (c *Client) HandleSetup(setup_data integration.SetupData) {
 
 	if c.setupFunc != nil {
-		c.setupFunc()
+		c.setupFunc(setup_data)
 	}
 
 }

pkg/client/deconzclient.go

@@ -133,7 +133,7 @@ func (c *DeconzClient) initDeconzClient() {
 
 }
 
-func (c *DeconzClient) deconzHandleSetup() {
+func (c *DeconzClient) deconzHandleSetup(setup_data integration.SetupData) {
 	//event_type: SETUP with state: SETUP is a progress event to keep the process running,
 	// If the setup process takes more than a few seconds,
 	// the integration should send driver_setup_change events with state: SETUP to the Remote Two

pkg/client/denonavrclient.go

@@ -97,7 +97,7 @@ func (c *DenonAVRClient) initDenonAVRClient() {
 
 }
 
-func (c *DenonAVRClient) denonHandleSetup() {
+func (c *DenonAVRClient) denonHandleSetup(setup_data integration.SetupData) {
 	//event_type: SETUP with state: SETUP is a progress event to keep the process running,
 	// If the setup process takes more than a few seconds,
 	// the integration should send driver_setup_change events with state: SETUP to the Remote Two

pkg/cmd/deconz/deconz.go

@@ -15,7 +15,7 @@ func NewCommand(rootCmd *cobra.Command) *cobra.Command {
 
 	var command = &cobra.Command{
 		Use:   "deconz",
-		Short: "Deconz",
+		Short: "Start Deconz Ingegration",
 		Long:  "Deconz Integration for a Unfolded Circle Remote Two",
 		Run: func(c *cobra.Command, args []string) {
 

pkg/cmd/denonavr/denonavr.go

@@ -15,7 +15,7 @@ func NewCommand(rootCmd *cobra.Command) *cobra.Command {
 
 	var command = &cobra.Command{
 		Use:   "denonavr",
-		Short: "Denon AVR",
+		Short: "Start Denon AVR Ingegration",
 		Long:  "Denon AVR Integration for a Unfolded Circle Remote Two",
 		Run: func(c *cobra.Command, args []string) {
 

pkg/entities/entities.go

@@ -11,6 +11,8 @@ const (
 	UnkownEntityState                  = "UNKNOWN"
 )
 
+// Generic Remote Two Entity
+// See https://github.com/unfoldedcircle/core-api/blob/main/doc/entities/README.md for details
 type Entity struct {
 	Id string `json:"entity_id"`
 	EntityType

pkg/integration/advertisement.go

@@ -6,15 +6,15 @@ import (
 	"github.com/grandcat/zeroconf"
 )
 
-// TODO: not working?
+// Start Advertising the integration with mDNS
 func (i *Integration) startAdvertising() {
 	log.Info("Start advertising UC Integration with mDNS")
 
 	txt := []string{
 		"name=" + i.Metadata.Name.En,
 		"developer=" + i.Metadata.Developer.Name,
 		"ver=" + i.Metadata.Version,
-		"ws_path=/ws",
+		"ws_path=" + i.Config["websocketPath"].(string),
 	}
 
 	server, err := zeroconf.Register(i.Metadata.DriverId, "_uc-integration._tcp", "local.", i.Config["listenport"].(int), txt, nil)
@@ -25,6 +25,7 @@ func (i *Integration) startAdvertising() {
 	i.mdns = server
 }
 
+// Stop mDNS advertisement
 func (i *Integration) stopAdvertising() {
 	if i.mdns != nil {
 		log.Info("Stop advertising UC Integration")

pkg/integration/config.go

@@ -1,3 +1,4 @@
 package integration
 
+// Generic string key/value config map to store configuration option
 type Config map[string]interface{}

pkg/integration/entities.go

@@ -241,6 +241,9 @@ func (i *Integration) handleCommand(entity interface{}, req *EntityCommandReq) i
 
 	case *entities.CoverEntity:
 		return e.HandleCommand(cmd_id, params)
+
+	case *entities.SensorEntity:
+		// Sensor do not have commands
 	}
 
 	return 404

pkg/integration/events.go

@@ -45,6 +45,7 @@ func (i *Integration) sendEventMessage(res *interface{}, messageType int) error
 
 }
 
+// Handle events received from the Remote
 func (i *Integration) handleEvent(req *RequestMessage, p []byte) interface{} {
 
 	var res interface{}

pkg/integration/integration.go

@@ -113,7 +113,7 @@ func (i *Integration) SetHandleSetDriverUserDataFunction(f func(map[string]strin
 	i.handleSetDriverUserDataFunction = f
 }
 
-// Send the Driver Setup State to Remote two
+// Set and then Send the Driver Setup State to Remote two
 func (i *Integration) SetDriverSetupState(event_Type DriverSetupEventType, state DriverSetupState, err DriverSetupError, requireUserAction *RequireUserAction) {
 
 	log.WithFields(log.Fields{

pkg/integration/websocket.go

@@ -50,7 +50,7 @@ func (i *Integration) wsEndpoint(w http.ResponseWriter, r *http.Request) {
 }
 
 func (i *Integration) wsReader(ws *websocket.Conn) {
-	log.Debug("Start Websocket read loop")
+	log.WithField("RemoteAddr", ws.RemoteAddr().String()).Debug("Start Websocket read loop")
 	ws.SetReadLimit(maxMessageSize)
 	ws.SetReadDeadline(time.Now().Add(pongWait))
 	ws.SetPongHandler(func(string) error {
@@ -102,7 +102,7 @@ func (i *Integration) wsReader(ws *websocket.Conn) {
 }
 
 func (i *Integration) wsWriter(ws *websocket.Conn) {
-	log.Debug("Start Websocket write loop")
+	log.WithField("RemoteAddr", ws.RemoteAddr().String()).Debug("Start Websocket write loop")
 	ticker := time.NewTicker(pingPeriod)
 
 	defer func() {