Skip to content

Latest commit

 

History

History
116 lines (78 loc) · 5.56 KB

devbox_setup.md

File metadata and controls

116 lines (78 loc) · 5.56 KB
Raw

Prepare your development environment

This document describes how to prepare your development environment to build and use the Microsoft Azure IoT device client SDK for .NET

  1. Prerequisites required to build the SDK
  2. Optional prerequisites required to test Xamarin, Windows IoT and .NET Micro Framework
  3. Test prerequisites

Prerequisites required to build the SDK

The following prerequisites are the minimum required to build and produce IoT SDK binaries. Visual Studio is not required to build the SDK. This may not be sufficient to run certain samples that require Visual Studio and other SDKs or frameworks installed on your machine.

Windows + .NET Framework

Linux/OSX (tested on Ubuntu 16.04)

Optional Setup required to test Xamarin, Windows IoT and .NET Micro Framework

Installing Visual Studio 2017 for Xamarin applications

  • Install Visual Studio 2017. You can use the Visual Studio Community Free download if you meet the licensing requirements.
  • During the installation of Visual Studio 2017, we found that selecting the following workloads and components helps in running and debugging the SDK.

Workloads:

Components:

Installing Windows IoT Core SDK

Install the Microsoft IoT Windows Core Project Templates for Visual Studio 2017 from the Extension Marketplace: https://marketplace.visualstudio.com/items?itemName=MicrosoftIoT.WindowsIoTCoreProjectTemplatesforVS15

Installing .NET Micro Framework

1. Download and Install Visual Studio Community 2015 Update 3 (approx. size: 9GB)

NetMF is not supported on VS2017. We recommend a separate virtual machine with VS2015. VS2015 Community is sufficient. Download from: https://www.visualstudio.com/vs/older-downloads/

Under Programming Languages, Visual C++ make sure that Common Tools for Visual C++ 2015 is selected.

2. Download and install .NET MicroFramework 4.4 and 4.3

  1. SDK v 4.4:
  • MicroFrameworkSDK.msi (SDK v4.4) - Complete Installation
  • NetMFVS14.vsx
  1. SDK 4.3 - The official site has been archived. Either:
  • Download the Codeplex archive (3.4GB) then unpack to find the MSI:
    • Under releases\13 unpack c4ad01a9-68f6-48cd-82e5-e6d154b0eb2f
    • Rename c4ad01a9-68f6-48cd-82e5-e6d154b0eb2f to netmf-v4.3.2-SDK-QFE2-RTM.zip and unzip
    • Install MicroFrameworkSDK.msi - Complete Installation
  • Download from http://developer.wildernesslabs.co/Netduino/About/Downloads/

3. Install .NET Framework 3.5

See the following documentation on how to enable this Windows component: https://docs.microsoft.com/en-us/dotnet/framework/install/dotnet-35-windows-10

Test prerequisites

Each test project that requires additional changes to your machine contains a prerequisites folder. Please follow the instructions within that folder on how to set-up your machine in order to successfully run our tests.

iothub/service/prerequisites one-time setup (Windows Only)

Run the following as admin: iothub\service\tests\prerequisites\windows_install.cmd

e2e/test/prerequisites

  1. Create copies of the prerequisite scripts in a separate folder (optionally include this folder in your PATH environment variable for easy access.

    • Windows: copy e2e/test/prerequisites/iot_config.cmd_template to a folder in your PATH iot_config.cmd
    • Linux/OSX: copy e2e/test/prerequisites/iot_config.sh_template to iot_config.sh

Do not check-in these files after you have edited them as they contain your account's secrets such as connection strings.

  1. Add the variables to your environment

    • Windows: run iot_config.cmd
    • Linux: dot-source the config file: . iot_config.sh

  2. Run the e2e tests or launch Visual Studio from the same command prompt/terminal.