FloraKit is a Swift Framework which makes it possible to read data from Xiaomi Mi Plant sensors.
- Reading Data from Sensors
- Error Handling
- Better Documentation
- Build real example instead of debug prints
- ℹ️ Add FloraKit features
The example application is the best way to see FloraKit in action. Simply open the FloraKit.xcodeproj and run the Example scheme.
FloraKit is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'FloraKit'Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.
To integrate FloraKit into your Xcode project using Carthage, specify it in your Cartfile:
github "jingx23/FloraKit"
Run carthage update to build the framework and drag the built FloraKit.framework into your Xcode project.
On your application targets’ “Build Phases” settings tab, click the “+” icon and choose “New Run Script Phase” and add the Framework path as mentioned in Carthage Getting started Step 4, 5 and 6
To integrate using Apple's Swift Package Manager, add the following as a dependency to your Package.swift:
dependencies: [
.package(url: "https://github.com/jingx23/FloraKit.git", from: "1.0.0")
]If you prefer not to use any of the aforementioned dependency managers, you can integrate FloraKit into your project manually. Simply drag the Sources Folder into your Xcode project.
ℹ️ Describe the usage of your Kit
Contributions are very welcome 🙌
FloraKit
Copyright (c) 2019 Jan Scheithauer me@jingx.net
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.