Provide source for commands sent

BuildTools/.swiftformat

@@ -5,6 +5,7 @@
 --exclude ../OpenHABCore/Sources/OpenHABCore/GeneratedSources
 --exclude ../OsLogRewriter/.build
 --exclude ../build
+--exclude ../CommonUI/.build
 --symlinks ignore
 
 # disabled rules

BuildTools/.swiftlint.yml

@@ -42,6 +42,7 @@ excluded:
   - ../OsLogRewriter/.build
   - ../build
   - ../BonjourDiscoveryTool
+  - ../CommonUI/.build
 
 nesting:
     type_level: 2

OpenHABCore/Sources/OpenHABCore/GeneratedSources/openapi/Client.swift

@@ -1440,6 +1440,18 @@ public struct Client: APIProtocol {
                     method: .post
                 )
                 suppressMutabilityWarning(&request)
+                try converter.setHeaderFieldAsURI(
+                    in: &request.headerFields,
+                    name: "X-OpenHAB-Source",
+                    value: input.headers.X_hyphen_OpenHAB_hyphen_Source
+                )
+                try converter.setQueryItemAsURI(
+                    in: &request,
+                    style: .form,
+                    explode: true,
+                    name: "source",
+                    value: input.query.source
+                )
                 let body: OpenAPIRuntime.HTTPBody?
                 switch input.body {
                 case let .plainText(value):
@@ -1448,6 +1460,12 @@ public struct Client: APIProtocol {
                         headerFields: &request.headerFields,
                         contentType: "text/plain"
                     )
+                case let .json(value):
+                    body = try converter.setRequiredRequestBodyAsJSON(
+                        value,
+                        headerFields: &request.headerFields,
+                        contentType: "application/json; charset=utf-8"
+                    )
                 }
                 return (request, body)
             },
@@ -1862,6 +1880,18 @@ public struct Client: APIProtocol {
                     name: "Accept-Language",
                     value: input.headers.Accept_hyphen_Language
                 )
+                try converter.setHeaderFieldAsURI(
+                    in: &request.headerFields,
+                    name: "X-OpenHAB-Source",
+                    value: input.headers.X_hyphen_OpenHAB_hyphen_Source
+                )
+                try converter.setQueryItemAsURI(
+                    in: &request,
+                    style: .form,
+                    explode: true,
+                    name: "source",
+                    value: input.query.source
+                )
                 let body: OpenAPIRuntime.HTTPBody?
                 switch input.body {
                 case let .plainText(value):

OpenHABCore/Sources/OpenHABCore/GeneratedSources/openapi/Types.swift

@@ -558,10 +558,14 @@ extension APIProtocol {
     /// - Remark: Generated from `#/paths//items/{itemname}/post(sendItemCommand)`.
     public func sendItemCommand(
         path: Operations.sendItemCommand.Input.Path,
+        query: Operations.sendItemCommand.Input.Query = .init(),
+        headers: Operations.sendItemCommand.Input.Headers = .init(),
         body: Operations.sendItemCommand.Input.Body
     ) async throws -> Operations.sendItemCommand.Output {
         try await sendItemCommand(Operations.sendItemCommand.Input(
             path: path,
+            query: query,
+            headers: headers,
             body: body
         ))
     }
@@ -632,11 +636,13 @@ extension APIProtocol {
     /// - Remark: Generated from `#/paths//items/{itemname}/state/put(updateItemState)`.
     public func updateItemState(
         path: Operations.updateItemState.Input.Path,
+        query: Operations.updateItemState.Input.Query = .init(),
         headers: Operations.updateItemState.Input.Headers = .init(),
         body: Operations.updateItemState.Input.Body
     ) async throws -> Operations.updateItemState.Output {
         try await updateItemState(Operations.updateItemState.Input(
             path: path,
+            query: query,
             headers: headers,
             body: body
         ))
@@ -7964,22 +7970,60 @@ public enum Operations {
                 }
             }
             public var path: Operations.sendItemCommand.Input.Path
+            /// - Remark: Generated from `#/paths/items/{itemname}/POST/query`.
+            public struct Query: Sendable, Hashable {
+                /// the source of the command
+                ///
+                /// - Remark: Generated from `#/paths/items/{itemname}/POST/query/source`.
+                public var source: Swift.String?
+                /// Creates a new `Query`.
+                ///
+                /// - Parameters:
+                ///   - source: the source of the command
+                public init(source: Swift.String? = nil) {
+                    self.source = source
+                }
+            }
+            public var query: Operations.sendItemCommand.Input.Query
+            /// - Remark: Generated from `#/paths/items/{itemname}/POST/header`.
+            public struct Headers: Sendable, Hashable {
+                /// the source of the command; takes priority over the query parameter or JSON body if multiple are set
+                ///
+                /// - Remark: Generated from `#/paths/items/{itemname}/POST/header/X-OpenHAB-Source`.
+                public var X_hyphen_OpenHAB_hyphen_Source: Swift.String?
+                /// Creates a new `Headers`.
+                ///
+                /// - Parameters:
+                ///   - X_hyphen_OpenHAB_hyphen_Source: the source of the command; takes priority over the query parameter or JSON body if multiple are set
+                public init(X_hyphen_OpenHAB_hyphen_Source: Swift.String? = nil) {
+                    self.X_hyphen_OpenHAB_hyphen_Source = X_hyphen_OpenHAB_hyphen_Source
+                }
+            }
+            public var headers: Operations.sendItemCommand.Input.Headers
             /// - Remark: Generated from `#/paths/items/{itemname}/POST/requestBody`.
             @frozen public enum Body: Sendable, Hashable {
                 /// - Remark: Generated from `#/paths/items/{itemname}/POST/requestBody/content/text\/plain`.
                 case plainText(OpenAPIRuntime.HTTPBody)
+                /// - Remark: Generated from `#/paths/items/{itemname}/POST/requestBody/content/application\/json`.
+                case json(Swift.String)
             }
             public var body: Operations.sendItemCommand.Input.Body
             /// Creates a new `Input`.
             ///
             /// - Parameters:
             ///   - path:
+            ///   - query:
+            ///   - headers:
             ///   - body:
             public init(
                 path: Operations.sendItemCommand.Input.Path,
+                query: Operations.sendItemCommand.Input.Query = .init(),
+                headers: Operations.sendItemCommand.Input.Headers = .init(),
                 body: Operations.sendItemCommand.Input.Body
             ) {
                 self.path = path
+                self.query = query
+                self.headers = headers
                 self.body = body
             }
         }
@@ -9009,18 +9053,42 @@ public enum Operations {
                 }
             }
             public var path: Operations.updateItemState.Input.Path
+            /// - Remark: Generated from `#/paths/items/{itemname}/state/PUT/query`.
+            public struct Query: Sendable, Hashable {
+                /// the source of the event
+                ///
+                /// - Remark: Generated from `#/paths/items/{itemname}/state/PUT/query/source`.
+                public var source: Swift.String?
+                /// Creates a new `Query`.
+                ///
+                /// - Parameters:
+                ///   - source: the source of the event
+                public init(source: Swift.String? = nil) {
+                    self.source = source
+                }
+            }
+            public var query: Operations.updateItemState.Input.Query
             /// - Remark: Generated from `#/paths/items/{itemname}/state/PUT/header`.
             public struct Headers: Sendable, Hashable {
                 /// language
                 ///
                 /// - Remark: Generated from `#/paths/items/{itemname}/state/PUT/header/Accept-Language`.
                 public var Accept_hyphen_Language: Swift.String?
+                /// the source of the event; takes priority over the query parameter or JSON body if multiple are set
+                ///
+                /// - Remark: Generated from `#/paths/items/{itemname}/state/PUT/header/X-OpenHAB-Source`.
+                public var X_hyphen_OpenHAB_hyphen_Source: Swift.String?
                 /// Creates a new `Headers`.
                 ///
                 /// - Parameters:
                 ///   - Accept_hyphen_Language: language
-                public init(Accept_hyphen_Language: Swift.String? = nil) {
+                ///   - X_hyphen_OpenHAB_hyphen_Source: the source of the event; takes priority over the query parameter or JSON body if multiple are set
+                public init(
+                    Accept_hyphen_Language: Swift.String? = nil,
+                    X_hyphen_OpenHAB_hyphen_Source: Swift.String? = nil
+                ) {
                     self.Accept_hyphen_Language = Accept_hyphen_Language
+                    self.X_hyphen_OpenHAB_hyphen_Source = X_hyphen_OpenHAB_hyphen_Source
                 }
             }
             public var headers: Operations.updateItemState.Input.Headers
@@ -9034,14 +9102,17 @@ public enum Operations {
             ///
             /// - Parameters:
             ///   - path:
+            ///   - query:
             ///   - headers:
             ///   - body:
             public init(
                 path: Operations.updateItemState.Input.Path,
+                query: Operations.updateItemState.Input.Query = .init(),
                 headers: Operations.updateItemState.Input.Headers = .init(),
                 body: Operations.updateItemState.Input.Body
             ) {
                 self.path = path
+                self.query = query
                 self.headers = headers
                 self.body = body
             }

OpenHABCore/Sources/OpenHABCore/Util/NetworkTracker.swift

@@ -528,11 +528,11 @@ public extension NetworkTracker {
     }
 
     func send(to item: String, command: String) async throws {
-        try await service().sendItemCommand(itemname: item, command: command)
+        try await service().sendItemCommand(itemname: item, command: command, sourcePrefix: nil, deviceId: nil)
     }
 
     func updateState(item: OpenHABItem, state: String) async throws {
-        try await service().updateItemState(itemname: item.name, with: state)
+        try await service().updateItemState(itemname: item.name, with: state, sourcePrefix: nil, deviceId: nil)
     }
 
     func getStaticItems() async throws -> [OpenHABItem] {

OpenHABCore/Sources/OpenHABCore/Util/OpenAPIService.swift

@@ -32,8 +32,8 @@ public enum OpenAPIServiceConfiguration {
 protocol OpenAPIServiceProtocol: AnyObject, Sendable {
     func getRootVersion() async throws -> Int
     @discardableResult func getRoot() async throws -> OpenHABServerProperties
-    func sendItemCommand(itemname: String, command: String) async throws
-    func updateItemState(itemname: String, with: String) async throws
+    func sendItemCommand(itemname: String, command: String, sourcePrefix: String?, deviceId: String?) async throws
+    func updateItemState(itemname: String, with: String, sourcePrefix: String?, deviceId: String?) async throws
     func getItems() async throws -> [OpenHABItem]
     func getItems(
         query: Operations.getItems.Input.Query
@@ -115,6 +115,24 @@ public actor OpenAPIService {
 //        config.timeoutIntervalForResource = config.timeoutIntervalForRequest + 25
         return config
     }
+
+    private func sourceComponent(deviceId: String?) -> String? {
+        let base = "org.openhab.ios"
+        guard let deviceId else { return base }
+        let trimmed = deviceId.trimmingCharacters(in: .whitespacesAndNewlines)
+        // Actor must not include the delegation separator per openHAB source spec.
+        if trimmed.isEmpty || trimmed.contains("=>") {
+            return base
+        }
+        return "\(base)$\(trimmed)"
+    }
+
+    private func buildSource(sourcePrefix: String?, deviceId: String?) -> String? {
+        let base = sourceComponent(deviceId: deviceId)
+        guard let sourcePrefix, !sourcePrefix.isEmpty else { return base }
+        guard let base else { return sourcePrefix }
+        return "\(sourcePrefix)=>\(base)"
+    }
 }
 
 public extension OpenAPIService {
@@ -333,17 +351,19 @@ public extension OpenAPIService {
 // MARK: State changes and commands
 
 public extension OpenAPIService {
-    func updateItemState(itemname: String, with state: String) async throws {
+    func updateItemState(itemname: String, with state: String, sourcePrefix: String? = nil, deviceId: String? = nil) async throws {
         let path = Operations.updateItemState.Input.Path(itemname: itemname)
         let body = Operations.updateItemState.Input.Body.plainText(.init(state))
-        let response = try await client.updateItemState(path: path, body: body)
+        let query = Operations.updateItemState.Input.Query(source: buildSource(sourcePrefix: sourcePrefix, deviceId: deviceId))
+        let response = try await client.updateItemState(path: path, query: query, body: body)
         _ = try response.accepted
     }
 
-    func sendItemCommand(itemname: String, command: String) async throws {
+    func sendItemCommand(itemname: String, command: String, sourcePrefix: String? = nil, deviceId: String? = nil) async throws {
         let path = Operations.sendItemCommand.Input.Path(itemname: itemname)
         let body = Operations.sendItemCommand.Input.Body.plainText(.init(command))
-        let response = try await client.sendItemCommand(path: path, body: body)
+        let query = Operations.sendItemCommand.Input.Query(source: buildSource(sourcePrefix: sourcePrefix, deviceId: deviceId))
+        let response = try await client.sendItemCommand(path: path, query: query, body: body)
         _ = try response.ok
     }
 }

OpenHABCore/Sources/OpenHABCore/openapi/openapi.json

@@ -2962,6 +2962,14 @@
         "summary": "Sends a command to an item.",
         "operationId": "sendItemCommand",
         "parameters": [
+          {
+            "name": "X-OpenHAB-Source",
+            "in": "header",
+            "description": "the source of the command; takes priority over the query parameter or JSON body if multiple are set",
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "name": "itemname",
             "in": "path",
@@ -2971,14 +2979,32 @@
               "pattern": "[a-zA-Z_0-9]+",
               "type": "string"
             }
+          },
+          {
+            "name": "source",
+            "in": "query",
+            "description": "the source of the command",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
-          "description": "valid item command (e.g. ON, OFF, UP, DOWN, REFRESH)",
+          "description": "Valid item command (e.g., ON, OFF) either as plain text or JSON",
           "content": {
             "text/plain": {
               "schema": {
-                "type": "string"
+                "type": "string",
+                "example": "ON"
+              }
+            },
+            "application/json": {
+              "schema": {
+                "type": "string",
+                "example": {
+                  "value": "ON",
+                  "source": "org.openhab.ios"
+                }
               }
             }
           },
@@ -3209,6 +3235,14 @@
               "type": "string"
             }
           },
+          {
+            "name": "X-OpenHAB-Source",
+            "in": "header",
+            "description": "the source of the event; takes priority over the query parameter or JSON body if multiple are set",
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "name": "itemname",
             "in": "path",
@@ -3218,6 +3252,14 @@
               "pattern": "[a-zA-Z_0-9]+",
               "type": "string"
             }
+          },
+          {
+            "name": "source",
+            "in": "query",
+            "description": "the source of the event",
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "requestBody": {

OpenHABCore/Tests/OpenHABCoreTests/NetworkTrackerTests.swift

@@ -36,13 +36,13 @@ final actor MockOpenAPIService: OpenAPIServiceProtocol {
         self.mockServerProperties = mockServerProperties
     }
 
-    func sendItemCommand(itemname: String, command: String) async throws {
+    func sendItemCommand(itemname: String, command: String, sourcePrefix: String?, deviceId: String?) async throws {
         if shouldFail {
             throw networkTrackerError
         }
     }
 
-    func updateItemState(itemname: String, with: String) async throws {
+    func updateItemState(itemname: String, with: String, sourcePrefix: String?, deviceId: String?) async throws {
         if shouldFail {
             throw networkTrackerError
         }