Skip to content

Commit 22b53ac

Browse files
committed
doc: update external link for release/v1.4
1 parent 1a4e390 commit 22b53ac

File tree

11 files changed

+18
-18
lines changed

11 files changed

+18
-18
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Direct-connected devices connect directly to the SmartThings cloud. The SDK for Direct Connected Devices is equipped to manage all MQTT topics and onboarding requirements, freeing you to focus on the actions and attributes of your device. To facilitate the development of device application in an original chipset SDK, the core device library and the examples were separated into two git repositories. That is, if you want to use the core device library in your original chipset SDK that installed before, you may simply link it to develop a device application in your existing development environment.
66

7-
It is distributed in source form and written in C99 for the purpose of portability to most platforms. If you want to know the overall workflow of using this SDK, please refer to the [Getting Started](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/master/doc/getting_started.md).
7+
It is distributed in source form and written in C99 for the purpose of portability to most platforms. If you want to know the overall workflow of using this SDK, please refer to the [Getting Started](./doc/getting_started.md).
88

99
## Directory layout
1010

@@ -13,7 +13,7 @@ The reference git is delivered via the following directory structure :
1313
- `apps` : sample device applications for each chipset
1414
- `bsp` : An original chipset vendor's SDK is located. If you use a chipset that has already been ported, this vendor's SDK can be easily downloaded as a submodule in this directory through the predefined script(e.g. `setup.py`).
1515
- `doc` : documents
16-
- `iot-core` : [IoT core device library](https://github.com/SmartThingsCommunity/st-device-sdk-c). It can also be downloaded as a submodule in this directory through the predefined script(e.g. `setup.py`).
16+
- `iot-core` : [IoT core device library](https://github.com/SmartThingsCommunity/st-device-sdk-c/tree/release/v1.4). It can also be downloaded as a submodule in this directory through the predefined script(e.g. `setup.py`).
1717
- `output` : build outputs will be placed
1818
- `patches` : patches to be applied in the original chipset vendor's SDK for resolving some problems
1919
- `tools` : scripts to be applied for each chipset
@@ -61,7 +61,7 @@ Basically, this release builds on the environments of chipset vendor's SDKs.
6161
- And then, run the `setup.py` to automatically download submodules to the `bsp` directory. At this time, the IoT core device library is also downloaded to the `iot-core` directory.
6262
```sh
6363
$ cd ~
64-
$ git clone https://github.com/SmartThingsCommunity/st-device-sdk-c-ref.git
64+
$ git clone https://github.com/SmartThingsCommunity/st-device-sdk-c-ref.git -b release/v1.4
6565
$ cd st-device-sdk-c-ref
6666
$ python setup.py
6767
Usage: python setup.py [BSP_NAME]

apps/emw3166/light_example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SmartThings direct-connected device is Wi-Fi enabled device that uses the SmartT
66

77
## Getting started
88

9-
For information on detailed workflow, please refer to the [Getting Started](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/master/doc/getting_started.md)
9+
For information on detailed workflow, please refer to the [Getting Started](../../../doc/getting_started.md)
1010

1111
## Components and Capabilities
1212

apps/emw3166/switch_example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SmartThings direct-connected device is Wi-Fi enabled device that uses the SmartT
66

77
## Getting started
88

9-
For information on detailed workflow, please refer to the [Getting Started](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/master/doc/getting_started.md)
9+
For information on detailed workflow, please refer to the [Getting Started](../../../doc/getting_started.md)
1010

1111
## Components and Capabilities
1212

apps/esp32/light_example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SmartThings direct-connected device is Wi-Fi enabled device that uses the SmartT
66

77
## Getting started
88

9-
For information on detailed workflow, please refer to the [Getting Started](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/master/doc/getting_started.md)
9+
For information on detailed workflow, please refer to the [Getting Started](../../../doc/getting_started.md)
1010

1111
## Components and Capabilities
1212

apps/esp32/switch_example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SmartThings direct-connected device is Wi-Fi enabled device that uses the SmartT
66

77
## Getting started
88

9-
For information on detailed workflow, please refer to the [Getting Started](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/master/doc/getting_started.md)
9+
For information on detailed workflow, please refer to the [Getting Started](../../../doc/getting_started.md)
1010

1111
## Components and Capabilities
1212

apps/rtl8195/light_example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SmartThings direct-connected device is Wi-Fi enabled device that uses the SmartT
66

77
## Getting started
88

9-
For information on detailed workflow, please refer to the [Getting Started](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/master/doc/getting_started.md)
9+
For information on detailed workflow, please refer to the [Getting Started](../../../doc/getting_started.md)
1010

1111
## Components and Capabilities
1212

apps/rtl8195/switch_example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SmartThings direct-connected device is Wi-Fi enabled device that uses the SmartT
66

77
## Getting started
88

9-
For information on detailed workflow, please refer to the [Getting Started](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/master/doc/getting_started.md)
9+
For information on detailed workflow, please refer to the [Getting Started](../../../doc/getting_started.md)
1010

1111
## Components and Capabilities
1212

apps/rtl8720c/switch_example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SmartThings direct-connected device is Wi-Fi enabled device that uses the SmartT
66

77
## Getting started
88

9-
For information on detailed workflow, please refer to the [Getting Started](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/master/doc/getting_started.md)
9+
For information on detailed workflow, please refer to the [Getting Started](../../../doc/getting_started.md)
1010

1111
## Components and Capabilities
1212

apps/rtl8721c/light_example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SmartThings direct-connected device is Wi-Fi enabled device that uses the SmartT
66

77
## Getting started
88

9-
For information on detailed workflow, please refer to the [Getting Started](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/master/doc/getting_started.md)
9+
For information on detailed workflow, please refer to the [Getting Started](../../../doc/getting_started.md)
1010

1111
## Components and Capabilities
1212

apps/rtl8721c/switch_example/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SmartThings direct-connected device is Wi-Fi enabled device that uses the SmartT
66

77
## Getting started
88

9-
For information on detailed workflow, please refer to the [Getting Started](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/blob/master/doc/getting_started.md)
9+
For information on detailed workflow, please refer to the [Getting Started](../../../doc/getting_started.md)
1010

1111
## Components and Capabilities
1212

doc/getting_started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,18 @@ The first thing you need to do is set up your programming environment.
2525

2626
There are two git repositories for working with the _SmartThings SDK for Direct Connected Devices_. The first git repository is for the Internet of Things (IoT) core device library itself, while the second git repository is for sample device applications that use this IoT core device library on the chipset vendor's own SDK.
2727

28-
- [IoT Core Device Library](https://github.com/SmartThingsCommunity/st-device-sdk-c)
29-
- [Reference](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref)
28+
- [IoT Core Device Library](https://github.com/SmartThingsCommunity/st-device-sdk-c/tree/release/v1.4)
29+
- [Reference](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/tree/release/v1.4)
3030

3131
#### Download Reference
3232

33-
You can just choose to download the [Reference repository](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref) from GitHub, if you use a chipset that has already been ported. In this case, the `IoT Core Device Library` and `a chipset SDK` can be easily downloaded as submodules in this Reference repository through the predefined `setup.py` script. If you are new for using the _SmartThings SDK for Direct Connected Devices_, we recommend you to use the [Reference repository](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref) for easier understanding.
33+
You can just choose to download the [Reference repository](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/tree/release/v1.4) from GitHub, if you use a chipset that has already been ported. In this case, the `IoT Core Device Library` and `a chipset SDK` can be easily downloaded as submodules in this Reference repository through the predefined `setup.py` script. If you are new for using the _SmartThings SDK for Direct Connected Devices_, we recommend you to use the [Reference repository](https://github.com/SmartThingsCommunity/st-device-sdk-c-ref/tree/release/v1.4) for easier understanding.
3434

3535
From the terminal, navigate to the directory you want the _SmartThings SDK for Direct Connected Devices_ to locate (e.g. `~/`) and clone it using the following git command:
3636

3737
```sh
3838
$ cd ~
39-
$ git clone https://github.com/SmartThingsCommunity/st-device-sdk-c-ref.git
39+
$ git clone https://github.com/SmartThingsCommunity/st-device-sdk-c-ref.git -b release/v1.4
4040
```
4141

4242
> **Note** :
@@ -320,7 +320,7 @@ Your IoT device needs two pieces of information when connecting to the SmartThin
320320
}
321321
}
322322
```
323-
This file can be generated by [stdk-keygen.py](https://github.com/SmartThingsCommunity/st-device-sdk-c/tree/master/tools/keygen#individual) like below example.
323+
This file can be generated by [stdk-keygen.py](https://github.com/SmartThingsCommunity/st-device-sdk-c/tree/release/v1.4/tools/keygen#individual) like below example.
324324
```sh
325325
python3 stdk-keygen.py --firmware switch_example_ver001 --mnid fJXX
326326
```
@@ -338,7 +338,7 @@ Your IoT device needs two pieces of information when connecting to the SmartThin
338338
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.
339339
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.
340340
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).
341-
[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.
341+
[stdk-keygen.py](https://github.com/SmartThingsCommunity/st-device-sdk-c/tree/release/v1.4/tools/keygen#commercial) also supports batch creation by reading csv formatted series of device serial number.
342342
343343
| Data Path | Description | Examples |
344344
| :------------ | :---------------------------- | :----------------------- |

0 commit comments

Comments
 (0)