https://github.com/openremote/console-ios-lib
ORLib iOS Swift Package for use in OR consoles implementation
https://github.com/openremote/console-ios-lib
Last synced: 4 months ago
JSON representation
ORLib iOS Swift Package for use in OR consoles implementation
- Host: GitHub
- URL: https://github.com/openremote/console-ios-lib
- Owner: openremote
- License: agpl-3.0
- Created: 2025-03-28T09:27:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-14T14:56:02.000Z (5 months ago)
- Last Synced: 2026-01-14T18:22:43.676Z (5 months ago)
- Language: Swift
- Size: 104 KB
- Stars: 0
- Watchers: 4
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ORLib
Library for OpenRemote iOS applications.
## Requirements
- iOS 15.0+
- Swift 5.5+
- Xcode 16.0+
## Installation
### Swift Package Manager
ORLib is available through [Swift Package Manager](https://swift.org/package-manager/).
To add ORLib to your Xcode project using Swift Package Manager:
1. In Xcode, select **File > Swift Packages > Add Package Dependency...**
2. Enter the repository URL: `https://github.com/openremote/ORLib.git`
3. Specify the version or branch you want to use
4. Select the ORLib package product
## Usage
```swift
import ORLib
// Your code using ORLib
```
## License
ORLib is available under the AGPL-3.0 license. See the LICENSE.txt file for more info.
## Protocol Buffer file
The ESPProvision provider uses Protocol Buffer to communicate with the ESP32 device.
The protobuf data specification is defined in the ORConfigChannelProtocol.proto file.
Compiling this to Swift code is performed manually using the protoc compiler by the developer
and the resulting Swift code is committed in the repository as part of the source code.
As indicated in [Generating stubs | Documentation](https://swiftpackageindex.com/grpc/grpc-swift-protobuf/2.1.2/documentation/grpcprotobuf/generating-stubs),
Protobuf compilation should not be part of the library build steps as it cannot be guaranteed to the library consumer has protoc available.