https://github.com/fgheysels/fg.iotedge.template
Visual Studio.NET template for creating IoT Edge projects.
https://github.com/fgheysels/fg.iotedge.template
azure azure-iot azure-iot-edge iot-edge-module
Last synced: about 2 months ago
JSON representation
Visual Studio.NET template for creating IoT Edge projects.
- Host: GitHub
- URL: https://github.com/fgheysels/fg.iotedge.template
- Owner: fgheysels
- Created: 2022-12-22T11:17:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-31T13:38:08.000Z (over 2 years ago)
- Last Synced: 2025-01-30T00:46:10.897Z (4 months ago)
- Topics: azure, azure-iot, azure-iot-edge, iot-edge-module
- Language: C#
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Introduction
When you create a new Azure IoT Edge module project via the Microsoft templates, you end up with a very basic project that still requires a lot of plumbing to be 'enterprise ready'.
The `fgiotedgemodule` template tries to offer an alternative where the IoT Edge module project that is generated by this template offers:
- Gracefull shutdown functionality for the IoT Edge module
- Logging via the ILogger infrastructure
- An easy way to load settings from the module twin
- The module supports a hosted environment by default which allows you to easily work with BackgroundProcesses and Dependency Injection. (Overrideable via the `no-backgroundservices` parameter)
# Using the template
The template can be installed (or updated) from your local machine by executing the `dotnet new install` command from the directory that contains the `.template.config` folder:
```cmd
dotnet new install ./
```
Afterwards, create a new Fg.IoTEdge.Module project via the CLI:
```cmd
dotnet new fgiotedgemodule -n
```
If you execute the above command in the directory where the `.sln` file of the Azure IoT Edge solution exists, then:
- The new project will be automatically added to the solution
- The `deployment.template.json` file of the IoT Edge solution will be updated so that the new module is incorporated in the deployment manifest.
The above command provides some parameters:
|parameter|description
|-|-|
|repository|The address of the image container repository. If not specified, the `module.json` file specifies the repository as a variable that can be set / replaced during deployment.
|no-backgroundservices|Specifies that a module must be generated which does not make use of hosted background-services. (Default: false)