Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/smartthingscommunity/st-device-sdk-c

SmartThings SDK for Direct Connected Devices for C
https://github.com/smartthingscommunity/st-device-sdk-c

iot-device mqtt opensource smartthings-sdk wifi

Last synced: about 2 hours ago
JSON representation

SmartThings SDK for Direct Connected Devices for C

Awesome Lists containing this project

README 

        
# SmartThings SDK for Direct Connected Devices for C



[![License](https://img.shields.io/badge/licence-Apache%202.0-brightgreen.svg?style=flat)](LICENSE)



The SmartThings SDK for Direct Connected Devices for C is the IoT core device library that allow device applications to securely connect to the SmartThings Cloud.

To facilitate the development of device application in your original chipset SDK that installed before, we provide this core device library as a separate repository.

You may simply link it to develop a device application in your existing development environment.



We also provide examples so that so that you can refer to how this core device library can be linked in existing original chipset SDKs and device applications can be developed.



It is distributed in source form and written in C99 for the purpose of portability to most platforms.



## Main features



This core device library provides the following features :



- Customized MQTT in order to reduce memory consumption and enhance stability

- Easy and efficient APIs

  - Connection APIs : You can do onboarding & MQTT connection by just calling only a few these APIs.

  - Capability APIs : More than hundred different capabilities can be implemented as only a few APIs.



## How to get started?



This core device library includes platform-dependent parts that should be built in a specific toolchain or SDK. That is, if you do NOT use the pre-porting environment, you must first port them to the appropriate environment.



After porting, you can use this library completely under the specific environment. For more information on detailed workflow below, please refer to the [Getting Started](./doc/getting_started.md). Maybe, we think it's more helpful to you



- Register a Device on Developer Workspace

- Develop a Device Application



## Porting SmartThings SDK for Direct Connected Devices for C



This core device library has platform-dependent directories. In current SDK version, those that must be ported are present in `src/port`.

By default, we have already provided several implementations based on some operating systems(e.g. FreeRTOS) and chipsets(e.g. ESPRESSIF). These porting examples in those directories make it easier for you to port to additional chipsets and operating systems.



For instructions on how to port this SDK, please see the [Porting Guide](./doc/porting_guide.md).



## Git Branch Guide



We are managing two git branch categories. One is `develop` branch. The other is `release/v{version}` branchs. In `devleop` branch, we are merging latest developing features actively. In `release/v{version}` branchs, we branch out from `devleop` branch and keep them stable updating bugfix and small amendment. If you want to use latest SDK features for test or POC, we recommand `devleop` branch as base. Or if you want to apply the SDK in real product and consider commercializing, we recommand `release/v{version}` branchs as base.



- `develop` branch : Latest devleoping features. Recommand for new feature test or POC.

- `release/v{version}` branchs : Tested and stable branchs. Recommand for Commercial product.



## Learn more



For more information, please review the following documents:



- [Getting Started](./doc/getting_started.md) : It covers the overall workflow and detailed steps for starters to work with SDK.

- [API References](./doc/APIs.md) : It provide all API reference that SDK offers.

- [Commercialization Guide](./doc/Commercialization_Guide) : It provides guide for ones who consider commercializing their IoT products with SDK.

- [Capabilities Reference](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference) : This page serves as a reference for the supported capabilities.

- [Developer Workspace](https://developer.smartthings.com/workspace/) : It provides functions related to device information registration and device integration in the SmartThings cloud.



## Contact



If you have any issue, or want to commercialize your IoT devices using this SDK, please contact [email protected] or open new issue.



## License



This library is licensed under the [Apache License Ver2.0](LICENSE).