You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-2Lines changed: 12 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -53,6 +53,12 @@ We are managing two git branch categories. One is `develop` branch. The other is
53
53
-`develop` branch : Latest devleoping features. Recommand for new feature test or POC.
54
54
-`release/v{version}` branchs : Tested and stable branchs. Recommand for Commercial product.
55
55
56
+
## Quick PoC development on Linux distribution
57
+
58
+
You can build and test the SDK on your Linux distribution environment without real target board. In this way, you can easily make PoC demo for your product and check your IoT device feasibility on SmartThings platform. Also in real product developing, building and testing on Linux environment can accelerate product development speed.
59
+
60
+
We provide `example/posix` example to demonstrate how to build and test the SDK on Linux distribution. But before running the example, you should acquire [Getting Started](./doc/getting_started.md) to be familiar with the SDK development process and register your test device profile on [Developer Workspace](https://developer.smartthings.com/workspace/). And this example skips onboarding(registering) process, so before test, you should register your device on the cloud manually with [manual onboarding tool](./tools/manual_onboarding/README.md) provided in `tools/manual_onboarding` folder.
61
+
56
62
## Learn more
57
63
58
64
For more information, please review the following documents:
@@ -63,9 +69,13 @@ For more information, please review the following documents:
63
69
-[Capabilities Reference](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference) : This page serves as a reference for the supported capabilities.
64
70
-[Developer Workspace](https://developer.smartthings.com/workspace/) : It provides functions related to device information registration and device integration in the SmartThings cloud.
65
71
66
-
## Contact
72
+
## Commercialization
73
+
74
+
For commercialization, refer to the following [link](https://github.com/SmartThingsCommunity/st-device-sdk-c/blob/main/doc/Commercialization_Guide).
67
75
68
-
If you have any issue, or want to commercialize your IoT devices using this SDK, please contact [email protected] or open new issue.
76
+
If you have any issue, or want to commercialize your IoT devices using this SDK, please use the following contact point.
-[STDK QR generation tool](https://github.com/SmartThingsCommunity/st-device-sdk-c/blob/main/doc/STDK_QR_Generation.md)
11
+
12
+
2. Created serial number, public key and private key shall be saved in the secure module.<br/>
13
+
Private key shall not be exposed to the outside and shall be injected and stored in the secure region of the device.
14
+
15
+
3. Serial Number and Device Public key shall be registered with Samsung SmartThings before sale.
16
+
17
+
4. QR should be attached to the device for the commercialization.
18
+
- The QR size requested for the product should meet the specifications below.
19
+
- Recommended : Above 10mm * 10mm
20
+
- Minimum : 7mm * 7mm
21
+
22
+
5. Products certified by WWST shall have a WWST logo attached to the product package.<br/> You can get the WWST(Work With Samsung SmartThings) Logo image with [the following link](https://partners.smartthings.com/brand-guidelines).
23
+
24
+
6. Products shall provide the firmware update function for security patch, feature upgrade, bug fix and etc.<br/>
25
+
If the partner has their own firmware update system, they can use it.<br/> But if not, they can implement it by referring to [the OTA guide](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/main/doc/ota_demo.md) we provide.
# How to create secure key for SmartThings Device SDK
2
+
3
+
### Introduction
4
+
SmartThings Device SDK allows users to pair their devices with the SmartThings App through a process called device onboarding.
5
+
During device onboarding, the device and user information shall be protected. To support, a key for encryption is required.
6
+
SmartThings Device SDK provides Key generation tool at `st-device-sdk-c/tools/keygen/` to help the developer.
7
+
But, if the developer has own key generation tool, they can use thiers
8
+
9
+
### How to use SmartThings Device SDK key generation tool
10
+
This example shows how to create ED25519 key pair with SDK tools. You can get device_info.json file as a result from tools/keygen/output_{ serialNumber}
11
+
Prefix 'STDK' means serial number for the developer.
# How to create QR code for SmartThings Device SDK
2
+
3
+
### Introduction
4
+
SmartThings Device SDK allows users to pair their devices with the SmartThings App through a process called device onboarding.
5
+
This "device onboarding" process involves confirming whether this device is owned by the user through the user's operation.
6
+
STDK provides four methods for this. These four methods are Just Works, Button Confirm, Pin Code Confirm, and QR Code Confirm.
7
+
When registering an onboarding profile in Developer Workspace, the developer can select methods may be used to check whether the device to be paired with the SmartThings App is owned by the user during onboarding.
8
+
Using QR code is not only used for user verification, but also helps user to onboarding user's device quickly and accurately.
9
+
In the "Add device" menu of the SmartThings App, the onboarding process starts by only scanning QR provided through the "Scan QR code".
10
+
11
+
### Information included in QR code
12
+
The QR code includes the following three pieces of information, and the manufacturer can generate the QR code with the information of each device and provide it to the user.
13
+
1. mnId - ID granted to the company. The developer can check this value in Develpoer Workspace or onboarding_profile.json.
14
+
2. setupId - A unique identification number in MNID (a.k.a Onboarding ID). The developer can check this value in Developer Workspace or onboarding_profile.json.
15
+
(A unique three-digit number that helps identifing this device onboarding)
16
+
3. SerialNumber - A UTF-8 URL encoded unique string assigned to each device. Developer shall use the serial number registered in Developer Workspace. Used serial number shall use safe characters in URLs.
Copy file name to clipboardExpand all lines: doc/getting_started.md
+23-24Lines changed: 23 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -99,7 +99,7 @@ Because maximum number of test device is limited per user, Once you reaches maxi
99
99
100
100
This example shows how to create ED25519 key pair with SDK tools. You can get device_info.json file as a result from tools/keygen/output_{ serialNumber}
101
101
102
-
Key generator utility (keygen.py) is located at `st-device-sdk-c/tools/keygen/`.
102
+
Key generator utility (stdk-keygen.py) is located at `st-device-sdk-c/tools/keygen/`.
103
103
Serial number for testing device would be randomly generated by this tool which has STDK + 12-digit alphanumberic format.
104
104
105
105
```sh
@@ -120,45 +120,44 @@ Copy public key string from keygen output (`nFN5x***uQusQ****ZHoBSFaAoP9***kNdLn
120
120
121
121
122
122
123
+
If you want to get more information for keygen tool, refer [STDK Key Generation](https://github.com/SmartThingsCommunity/st-device-sdk-c/blob/main/doc/STDK_Key_Generation.md)
123
124
124
125
125
-
### (Optional)Generate Device QR code
126
-
Using device QR code could be helpful while device onboarding. QR code should have format like below. (Please refer here for more details)
127
-
128
-
This link is [QR code design template] (https://developer.smartthings.com/docs/devices/direct-connected/publish#qr-code-design-template).
126
+
### Generate Device QR code
127
+
Using device QR code could be helpful while device onboarding. QR code should have format like below.
128
+
This link is [QR code design template](https://developer.smartthings.com/docs/devices/direct-connected/publish#qr-code-design-template).
129
129
130
130
**{Your mnId}**: 4-digit alphanumeric mnId of your account
131
-
**{Device onboardingId}**: 3-digit number Onboarding ID, you can find it from your developer workspace project “Device Onboarding” > “Other Info” page
131
+
**{Device setupId}**: 3-digit number setupId, you can find it from your developer workspace project “Device Onboarding” > “Other Info” page
132
132
**{Device serialNumber}**: device serial number which is registered at your developer workspace project
QR generator utility (stdk-qrgen.py) is located at `st-device-sdk-c/tools/qrgen/`.
139
+
To generate QR, `onboarding_config.json` and `device_info.json` should be located at `st-device-sdk-c/tools/qrgen/`.
140
+
onboarding_config.json can download on [Developer Workspace](https://github.com/SmartThingsCommunity/st-device-sdk-c/blob/main/doc/getting_started.md#download-onboarding_configjson)
141
+
device_info.json can get on 'st-device-sdk-c/tools/keygen/output_{serialNumber}'.
142
+
```sh
143
+
$ cd {SDK_ROOT}/tools/qrgen/
144
+
$ python3 stdk-qrgen.py
145
+
File: {Device serialNumber}.png
146
+
QR url: https://qr.samsungiots.com/?m={Your mnId}&s={Device onboardingId}&r={Device serialNumber}
149
147
```
148
+
149
+
If you want to get more information for QR tool, refer [STDK QR Generation](https://github.com/SmartThingsCommunity/st-device-sdk-c/blob/main/doc/STDK_QR_Generation.md)
150
150
151
151
152
152
### Download onboarding_config.json
153
153
154
-
This is the information that the IoT device must have in order to connect to the SmartThings Platform.
154
+
This is the information that the IoT device shall have in order to connect to the SmartThings Platform.
155
155
156
156
If you use a sample device application in example directory from this git repository, please download it and then, just overwrite the existing `onboarding_config.json` file with the new one you downloaded. In fact, overwriting is just one of several possible ways to inject it to the device. If the json information is guaranteed to be a parameter in the `st_conn_init()` function, you can refer to it differently according to your own development way.
@@ -185,7 +184,7 @@ Your IoT device needs two pieces of information when connecting to the SmartThin
185
184
186
185
We have two type of the format of `device_info.json`.
187
186
188
-
- **All inclusive**
187
+
- **All inclusive (For development)**
189
188
190
189
`device_info.json` file could include all the information as json format. Our SmartThings Device SDK sample application uses this method.
191
190
This is the easiest and simplest way to contain security information for devices. But having per device specific information as json format may not be suitable for manufacturing. So this is recommended for the test devices for individual developer.
@@ -204,7 +203,7 @@ Your IoT device needs two pieces of information when connecting to the SmartThin
We can leave only the firmware version at `device_info.json` like below.
210
209
```json
@@ -214,7 +213,7 @@ Your IoT device needs two pieces of information when connecting to the SmartThin
214
213
}
215
214
}
216
215
```
217
-
In this case other sercurity information like device private key, device public key and device serial number should be moved to dedicated secure partition - called as SmartThings Non-Volatile (STNV) Partition - with `CONFIG_STDK_IOT_CORE_SUPPORT_STNV_PARTITION` option enabled.
216
+
For commercial, other sercurity information like device private key, device public key and device serial number should be moved to dedicated secure partition - called as SmartThings Non-Volatile (STNV) Partition - with `CONFIG_STDK_IOT_CORE_SUPPORT_STNV_PARTITION` option enabled.
218
217
This is subitable for manufacturing because it could have dedicated secure partition for immutable information. SmartThings Device SDK expect security information from STNV parition with below path name.
219
218
The mapping between `iot_nvd_t` and real storage path name can be found at `iot_bsp_nv_data_XXX.c`for [each bsp's porting layer](https://github.com/SmartThingsCommunity/st-device-sdk-c/tree/master/src/port/bsp).
220
219
[stdk-keygen.py](https://github.com/SmartThingsCommunity/st-device-sdk-c/tree/master/tools/keygen#commercial) also supports batch creation by reading csv formatted series of device serial number.
0 commit comments