Skip to content

Commit

Permalink
updates to docs for vcpkg and lts (#856)
Browse files Browse the repository at this point in the history
* updates for vcpkg and lts readmes
* LTS version update
  • Loading branch information
massand authored Feb 22, 2019
1 parent 609482a commit adfb14c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 66 deletions.
68 changes: 4 additions & 64 deletions doc/devbox_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This document describes how to prepare your development environment to use the *
## Set up a Windows development environment

- Install [Visual Studio 2017][visual-studio]. You can use the **Visual Studio Community** Free download if you meet the licensing requirements. (**Visual Studio 2015** is also supported.)
> Be sure to include Visual C++ and NuGet Package Manager.
> Be sure to include Visual C++.
- Install [git]. Confirm git is in your PATH by typing `git version` from a command prompt.

Expand All @@ -32,6 +32,8 @@ git clone -b <yyyy-mm-dd> --recursive https://github.com/Azure/azure-iot-sdk-c.g
### Build a sample application without building the SDK

The sample applications build with the help of C SDK libraries and headers published from vcpkg (a library manager). To install the C SDK libraries and headers, follow the steps to [Setup C SDK vcpkg for Windows development environment](https://github.com/Azure/azure-iot-sdk-c/blob/master/doc/setting_up_vcpkg.md#setup-c-sdk-vcpkg-for-windows-development-environment).

To quickly build one of our sample applications, open the corresponding [solution file][sln-file] (.sln) in Visual Studio.
For example, to build the **telemetry message sample**, open **iothub_client\samples\iothub_ll_telemetry_sample\windows\iothub_ll_telemetry_sample.sln**.

Expand All @@ -43,7 +45,7 @@ static const char* connectionString = "[device connection string]";

...and replace `[device connection string]` with a valid device connection string for a device registered with your IoT Hub. For more information, see the [samples section](#samplecode) below.

Build the sample project. As part of the build, [NuGet] Package Manager will download packages for dependencies so you don't have to build the entire SDK. See **windows\packages.config** for the list of packages that will be downloaded.
Build the sample project.

### Build the C SDK in Windows

Expand Down Expand Up @@ -340,67 +342,6 @@ with</br>

The example above assumes curl 7.58 has been compiled and saved into `/usr/local/Cellar/curl/7.58.0`. For more details please see section "Upgrade CURL on Mac OS".

<a name="windowsce"></a>

## [**DEPRECATED**: Set up a Windows Embedded Compact 2013 development environment
***WINDOWS EMBEDDED COMPACT 2013 RECEIVES MINIMAL SUPPORT FROM AZURE IOT SDK.*** In particular please be aware:
* No new features will be added to WEC.
* The only supported protocol is HTTPS. Popular protocols like AMQP and MQTT, both over TCP directly and over WebSockets, are not and will not be supported.
* HTTPS over proxy is not supported.
* Developers may want to evaluate [Windows 10 IoT Core], which has much broader Azure IoT SDK support.

**SETUP INSTRUCTIONS FOR WINDOWS EMBEDDED COMPACT 2013**

- Install [Visual Studio 2015][visual-studio]. You can use the **Visual Studio Community** Free download if you meet the licensing requirements.
> Be sure to include Visual C++ and NuGet Package Manager.

- Install [Application Builder for Windows Embedded Compact 2013][application-builder] for Visual Studio 2015
- Install [Toradex Windows Embedded Compact 2013 SDK][toradex-CE8-sdk] or your own SDK.

- Install [git]. Confirm git is in your PATH by typing `git version` from a command prompt.

- Install [CMake]. Make sure it is in your PATH by typing `cmake -version` from a command prompt. CMake will be used to create Visual Studio projects to build libraries and samples.

- Locate the tag name for the [latest release][latest-release] of the SDK.
> Our release tag names are date values in `yyyy-mm-dd` format.

- Clone the latest release of SDK to your local machine using the tag name you found:

```Shell
git clone -b <yyyy-mm-dd> --recursive https://github.com/Azure/azure-iot-sdk-c.git
```

> The `--recursive` argument instructs git to clone other GitHub repos this SDK depends on. Dependencies are listed [here](https://github.com/Azure/azure-iot-sdk-c/blob/master/.gitmodules).

If you installed a different SDK please check azure-iot-sdk-c\\build_all\\windowsce\\build.cmd and replace:

```Shell
set SDKNAME=TORADEX_CE800
set PROCESSOR=arm
```

with a reference to the name of the SDK and the processor architecture (arm/x86) you plan to use.

### Verify your environment

You can build the Windows samples to verify that your environment is set up correctly.

- Open a "Developer Command Prompt for VS2015".
- Navigate to the **build_all\\windowsce** folder in your local copy of the repository.
- Run the following command:

```Shell
build
```

This script uses CMake to create a folder called "cmake\_ce8" in your home directory and generates in that folder a Visual Studio solution called azure_iot_sdks.sln. The script will then proceed to build the **HTTP** sample.

> Note: you will not be able to run the samples until you configure them with a valid IoT hub device connection string. For more information, see [running a C sample application on Windows Embedded Compact 2013 on a Toradex module](https://github.com/Azure/azure-iot-device-ecosystem/blob/master/get_started/wince2013-toradex-module-c.md).

To view the projects and examine the source code, open the **azure_iot_sdks.sln** solution file in Visual Studio.

You can use one of the sample applications as a template to get started when you are creating your own client applications.

<a name="samplecode"></a>

## Sample applications
Expand Down Expand Up @@ -436,7 +377,6 @@ make
[azure-umqtt-c]:https://github.com/Azure/azure-umqtt-c
[sln-file]:https://msdn.microsoft.com/en-us/library/bb165951.aspx
[git]:http://www.git-scm.com
[NuGet]:https://www.nuget.org/
[CMake]:https://cmake.org/
[MSBuild]:https://msdn.microsoft.com/en-us/library/0k6kkbsd.aspx
[OpenSSL]:https://www.openssl.org/
Expand Down
3 changes: 1 addition & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,9 +222,8 @@ Below is a table showing the mapping of the LTS branches to the packages release

| Package | Github Branch | LTS Status | LTS Start Date | Maintenance End Date | Removed Date |
| :-----------: | :-----------: | :--------: | :------------: | :------------------: | :----------: |
| Vcpkg: 1.2.14-1<br/> Xenial: 0.2.0.0-16xenial<br/> Trusty: 0.2.0-16trusty<br/> Bionic: 0.2.0.0-9bionic<br/> | lts_01_2019 | Active | 2019-01-31 | 2020-01-31 | 2020-01-31 |
| Nuget: 1.2.10<br/> Xenial: 0.2.0.0-12xenial<br/> Trusty: 0.2.0-12trusty<br/> Bionic: 0.2.0.0-5bionic<br/> | lts_10_2018 | Active | 2018-10-03 | 2019-10-03 | 2019-10-03 |
| Nuget: 1.1.33<br/> Xenial: 0.1.0.0-35xenial<br/> Trusty: 0.1.0-37trusty<br/> | lts_01_2018 | Active | 2018-01-01 | 2018-12-31 | 2018-04-31 |


* <sup>1</sup> All scheduled dates are subject to change by the Azure IoT SDK team.

Expand Down

0 comments on commit adfb14c

Please sign in to comment.