Update README.md (#21)

***NO_CI***

Author: AdrianSoundy

.github/workflows/update-dependencies.yml

@@ -7,8 +7,8 @@ name: Daily update dependencies
 
 on:
   schedule:
-  # At 00:00 UTC every day.
-  - cron:  '00 00 * * *'
+  # Update At 00:00 UTC on Tuesday and Friday
+  - cron:  '0 0 * * 2,5'
   repository_dispatch:
     types: update-dependencies
 
@@ -17,36 +17,16 @@ defaults:
     shell: pwsh
 
 jobs:
-  update-dotnet-preview:
+  update-nuget-dependencies:
     name: Update .NET nanoFramework dependencies
-    timeout-minutes: 15
+    timeout-minutes: 180 # Non default as IoT devices has lots of solutions to update!
     runs-on: windows-latest
+    env:
+      GITHUB_TOKEN: ${{ github.token }}
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-        with:
-          path: main
-      - name: Checkout tools repo
-        uses: actions/checkout@v2
-        with:
-          repository: nanoframework/nf-tools
-          path: tools
       - name: Update dependencies
-        run: ./github-actions/update-nf-dependencies.ps1
-        working-directory: tools
-      - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v3
-        if: env.CREATE_PR == 'true'
+        uses: nanoframework/nanodu@v1
         with:
-          title: '${{ env.PR_TITLE }}'
-          body: |
-            ${{ env.PR_MESSAGE }}
-            
-            [version update]
-            
-            ### :warning: This is an automated update. :warning:
-          committer: 'nfbot <[email protected]>'
-          branch: ${{ env.BRANCH_NAME }}
-          path: main
-          labels: |
-            Type: dependencies
+          solutionsToCheck: 'nanoFramework.Device.Bluetooth.sln'

CHANGELOG.md

@@ -0,0 +1,139 @@
+# Changelog
+
+## [**Changes available only in 'Preview' NuGet packages:**](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/HEAD)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.24...HEAD)
+
+**Documentation and other chores:**
+
+- Update 4 NuGet dependencies [\#20](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/20)
+
+## [v1.0.0-preview.24](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.24) (2022-03-16)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.23...v1.0.0-preview.24)
+
+**Implemented enhancements:**
+
+- Update to allow adding of extra services [\#19](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/19)
+
+## [v1.0.0-preview.23](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.23) (2022-03-14)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.21...v1.0.0-preview.23)
+
+**Documentation and other chores:**
+
+- Update 1 NuGet dependencies [\#18](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/18)
+- Update 1 NuGet dependencies [\#17](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/17)
+
+## [v1.0.0-preview.21](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.21) (2022-03-14)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.18...v1.0.0-preview.21)
+
+**Documentation and other chores:**
+
+- Update 3 NuGet dependencies [\#15](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/15)
+- Update 1 NuGet dependencies [\#14](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/14)
+
+## [v1.0.0-preview.18](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.18) (2022-02-17)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.17...v1.0.0-preview.18)
+
+**Documentation and other chores:**
+
+- Update 3 NuGet dependencies [\#13](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/13)
+
+## [v1.0.0-preview.17](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.17) (2022-02-08)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.16...v1.0.0-preview.17)
+
+**Documentation and other chores:**
+
+- Update 1 NuGet dependencies [\#12](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/12)
+
+## [v1.0.0-preview.16](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.16) (2022-02-04)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.15...v1.0.0-preview.16)
+
+**Documentation and other chores:**
+
+- Update 1 NuGet dependencies [\#11](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/11)
+
+## [v1.0.0-preview.15](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.15) (2022-01-28)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.14...v1.0.0-preview.15)
+
+**Documentation and other chores:**
+
+- Update 1 NuGet dependencies [\#10](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/10)
+
+## [v1.0.0-preview.14](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.14) (2022-01-28)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.13...v1.0.0-preview.14)
+
+**Documentation and other chores:**
+
+- Update 4 NuGet dependencies [\#9](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/9)
+
+## [v1.0.0-preview.13](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.13) (2022-01-21)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.12...v1.0.0-preview.13)
+
+**Documentation and other chores:**
+
+- Update 1 NuGet dependencies [\#8](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/8)
+
+## [v1.0.0-preview.12](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.12) (2022-01-21)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.11...v1.0.0-preview.12)
+
+**Documentation and other chores:**
+
+- Update 1 NuGet dependencies [\#7](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/7)
+
+## [v1.0.0-preview.11](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.11) (2022-01-20)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.9...v1.0.0-preview.11)
+
+**Documentation and other chores:**
+
+- Update 3 NuGet dependencies [\#6](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/6)
+
+## [v1.0.0-preview.9](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.9) (2022-01-04)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.8...v1.0.0-preview.9)
+
+**Documentation and other chores:**
+
+- Update 1 nuget dependencies [\#5](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/5)
+
+## [v1.0.0-preview.8](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.8) (2021-12-28)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.6...v1.0.0-preview.8)
+
+**Documentation and other chores:**
+
+- Bumps nanoFramework.Runtime.Events from 1.9.2 to 1.10.0-preview.1 [\#4](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/4)
+
+## [v1.0.0-preview.6](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.6) (2021-12-03)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/v1.0.0-preview.4...v1.0.0-preview.6)
+
+**Documentation and other chores:**
+
+- Update 4 nuget dependencies [\#3](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/3)
+
+## [v1.0.0-preview.4](https://github.com/nanoframework/nanoframework.Device.Bluetooth/tree/v1.0.0-preview.4) (2021-12-03)
+
+[Full Changelog](https://github.com/nanoframework/nanoframework.Device.Bluetooth/compare/132574ccaaaa8f9e99b0a27a3b6ec6a0a9709f29...v1.0.0-preview.4)
+
+**Implemented enhancements:**
+
+- Initial Bluetooth project  [\#1](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/1)
+
+**Documentation and other chores:**
+
+- Update Readme.md [\#2](https://github.com/nanoframework/nanoFramework.Device.Bluetooth/pull/2)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

NFUnitTest1/NFUnitTest1.nfproj

@@ -31,25 +31,21 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
   </ItemGroup>
   <ItemGroup>
-    <Reference Include="mscorlib, Version=1.10.5.4, Culture=neutral, PublicKeyToken=c07d481e9758c731">
-      <HintPath>..\packages\nanoFramework.CoreLibrary.1.10.5\lib\mscorlib.dll</HintPath>
+    <Reference Include="mscorlib, Version=1.12.0.0, Culture=neutral, PublicKeyToken=c07d481e9758c731">
+      <HintPath>..\packages\nanoFramework.CoreLibrary.1.12.0-preview.19\lib\mscorlib.dll</HintPath>
       <Private>True</Private>
-      <SpecificVersion>True</SpecificVersion>
     </Reference>
-    <Reference Include="nanoFramework.System.Text, Version=1.1.1.3, Culture=neutral, PublicKeyToken=c07d481e9758c731">
-      <HintPath>..\packages\nanoFramework.System.Text.1.1.1\lib\nanoFramework.System.Text.dll</HintPath>
+    <Reference Include="nanoFramework.System.Text, Version=1.1.3.0, Culture=neutral, PublicKeyToken=c07d481e9758c731">
+      <HintPath>..\packages\nanoFramework.System.Text.1.1.3-preview.24\lib\nanoFramework.System.Text.dll</HintPath>
       <Private>True</Private>
-      <SpecificVersion>True</SpecificVersion>
     </Reference>
-    <Reference Include="nanoFramework.TestFramework, Version=1.0.150.0, Culture=neutral, PublicKeyToken=c07d481e9758c731">
-      <HintPath>..\packages\nanoFramework.TestFramework.1.0.150\lib\nanoFramework.TestFramework.dll</HintPath>
+    <Reference Include="nanoFramework.TestFramework, Version=1.0.181.0, Culture=neutral, PublicKeyToken=c07d481e9758c731">
+      <HintPath>..\packages\nanoFramework.TestFramework.1.0.181\lib\nanoFramework.TestFramework.dll</HintPath>
       <Private>True</Private>
-      <SpecificVersion>True</SpecificVersion>
     </Reference>
     <Reference Include="nanoFramework.UnitTestLauncher, Version=0.0.0.0, Culture=neutral, PublicKeyToken=c07d481e9758c731">
-      <HintPath>..\packages\nanoFramework.TestFramework.1.0.150\lib\nanoFramework.UnitTestLauncher.exe</HintPath>
+      <HintPath>..\packages\nanoFramework.TestFramework.1.0.181\lib\nanoFramework.UnitTestLauncher.exe</HintPath>
       <Private>True</Private>
-      <SpecificVersion>True</SpecificVersion>
     </Reference>
   </ItemGroup>
   <ItemGroup>
@@ -61,16 +57,16 @@
   </ItemGroup>
   <Import Project="$(NanoFrameworkProjectSystemPath)NFProjectSystem.CSharp.targets" Condition="Exists('$(NanoFrameworkProjectSystemPath)NFProjectSystem.CSharp.targets')" />
   <!-- MANUAL UPDATE HERE -->
-  <Import Project="..\packages\nanoFramework.TestFramework.1.0.150\build\nanoFramework.TestFramework.targets" Condition="Exists('..\packages\nanoFramework.TestFramework.1.0.150\build\nanoFramework.TestFramework.targets')" />
   <ProjectExtensions>
     <ProjectCapabilities>
       <ProjectConfigurationsDeclaredAsItems />
     </ProjectCapabilities>
   </ProjectExtensions>
+  <Import Project="..\packages\nanoFramework.TestFramework.1.0.181\build\nanoFramework.TestFramework.targets" Condition="Exists('..\packages\nanoFramework.TestFramework.1.0.181\build\nanoFramework.TestFramework.targets')" />
   <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
     <PropertyGroup>
-      <WarningText>Update the Import path in nfproj to the correct nanoFramework.TestFramework NuGet package folder.</WarningText>
+      <ErrorText>This project references NuGet package(s) that are missing on this computer. Enable NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105.The missing file is {0}.</ErrorText>
     </PropertyGroup>
-    <Warning Condition="!Exists('..\packages\nanoFramework.TestFramework.1.0.150\build\nanoFramework.TestFramework.targets')" Text="'$(WarningText)'" />
+    <Error Condition="!Exists('..\packages\nanoFramework.TestFramework.1.0.181\build\nanoFramework.TestFramework.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\nanoFramework.TestFramework.1.0.181\build\nanoFramework.TestFramework.targets'))" />
   </Target>
 </Project>

NFUnitTest1/packages.config

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="nanoFramework.CoreLibrary" version="1.10.5" targetFramework="netnanoframework10" />
-  <package id="nanoFramework.System.Text" version="1.1.1" targetFramework="netnanoframework10" />
-  <package id="nanoFramework.TestFramework" version="1.0.150" targetFramework="netnanoframework10" developmentDependency="true" />
+  <package id="nanoFramework.CoreLibrary" version="1.12.0-preview.19" targetFramework="netnanoframework10" />
+  <package id="nanoFramework.System.Text" version="1.1.3-preview.24" targetFramework="netnanoframework10" />
+  <package id="nanoFramework.TestFramework" version="1.0.181" targetFramework="netnanoframework10" developmentDependency="true" />
 </packages>

README.md

@@ -18,30 +18,37 @@
 Bluetooth Low Energy library.
 
 This library is based on the Windows.Devices.Bluetooth UWP class library but simplified and with all the async related calls removed.
-The original .Net assembly depended on Windows.Storage.Streams for DataReader & DataWriter; this library has simplified inbuilt versions. References to IBuffer in .Net UWP examples should now use Buffer instead.
+The original .Net assembly depended on Windows.Storage.Streams for DataReader & DataWriter; this library has simplified inbuilt versions. 
+So references to IBuffer in .Net UWP examples should now use Buffer instead. 
 
-Currently only supported on ESP32 devices with following firmware.
+We have also added an extension to this assembly allowing extra services to be added with no restriction on type.
+
+## Firmware versions
+
+Bluetooth is currently only supported on ESP32 devices with following firmware.
 
 - ESP32_BLE_REV0
 - ESP32_BLE_REV3
 
 This restriction is due to IRAM memory space in the firmware image. 
-With revision 1 ESP32 devices the PSRAM implementation requires PSRAM fixes which takes space
-in IRAM so PSRAM is currently disabled for ESP32_BLE_REV0.  With the revision 3 devices the Bluetooth and 
-PSRAM and are both available.
+With revision 1 of ESP32 devices, the PSRAM implementation requires a large number of PSRAM fixes which reduces the 
+available space in the IRAM area so PSRAM is currently disabled for ESP32_BLE_REV0. With the revision 3 devices the Bluetooth and 
+PSRAM are both available.
 
 ## Samples
 
-A number of Bluetooth LE samples are available in the [nanoFramework samples repo](https://github.com/nanoframework/Samples)
+A number of Bluetooth LE samples are available in the [nanoFramework samples repo](https://github.com/nanoframework/Samples/)
 
-- Nordic Spp Sample. (coming soon)
-- Environmental sensor sample. (coming soon)
+- [Bluetooth Low energy sample 1 (Basic Read/Write/Notify)](https://github.com/nanoframework/Samples/tree/main/samples/Bluetooth/BluetoothLESample1)
+- [Bluetooth Low energy sample 2 (Add Security)](https://github.com/nanoframework/Samples/tree/main/samples/Bluetooth/BluetoothLESample2)
+- [Bluetooth Low energy sample 3 (Show cases adding or replacing some standard services)](https://github.com/nanoframework/Samples/tree/main/samples/Bluetooth/BluetoothLESample3)
+- [Bluetooth Low energy serial (SPP)](https://github.com/nanoframework/Samples/tree/main/samples/Bluetooth/BluetoothLESerial) 
 
 ## Usage
 
 ### Overview
 
-The current implementation only supports the Gatt Server calls. 
+The current implementation only supports the Gatt Server calls. A future version will include the Gatt Client. 
 
 Also as part of this assembly is the NordicSPP class which implements a Serial Protocol Profile based on 
 the Nordic specification. This allows clients to easily connect via Bluetooth LE to send and receive messages via a 
@@ -261,6 +268,33 @@ private static void _notifyCharacteristic_SubscribedClientsChanged(GattLocalChar
 }
 ```
 
+### Adding extra services
+You can add or replace existing services and there are no restrictions on which services you add. 
+See the Bluetooth sample 3 for an example of adding the bluetooth standard 
+services, Device Information, Current Time, Battery level and Environmental Sensor.
+
+```csharp
+// Battery service exposes the current battery level percentage
+BatteryService BatService = new BatteryService(serviceProvider);
+
+// Update the Battery service with the current battery level when ever it is read.
+BatService.BatteryLevel = 94;
+```
+
+## Advertising your service
+
+Once all the Characteristics have been created you need to advertise the Service so other devices can see it 
+and/or connect to it. We also provide the device name seen on the disovery.
+
+```csharp
+serviceProvider.StartAdvertising(new GattServiceProviderAdvertisingParameters()
+{
+    DeviceName = "My Example Device",
+    IsConnectable = true,
+    IsDiscoverable = true
+});
+```
+
 # Bluetooth Serial Port Profile(SPP)
 
 This assembly has an implementation of the Nordic SPP which can easily be used to send messages between a Bluetooth client and the device 

azure-pipelines.yml

@@ -1,10 +1,28 @@
+# Copyright (c) .NET Foundation and Contributors
+# See LICENSE file in the project root for full license information.
+
 trigger:
   branches:
-    include: [main, develop, "release-*" ]
+    include:
+      - main
+      - develop
+      - release-*
   paths:
-    exclude: [README.md, LICENSE.md, CHANGELOG.md, "*.md", NuGet.Config, .github_changelog_generator, .gitignore]
+    exclude:
+      - .github_changelog_generator
+      - .gitignore
+      - CHANGELOG.md
+      - CODE_OF_CONDUCT.md
+      - LICENSE.md
+      - README.md
+      - NuGet.Config
+      - assets/*
+      - config/*
+      - .github/*
+
   tags:
-    include: ["v*"]
+    include: 
+      - v*
 
 # PR always trigger build
 pr:
@@ -19,7 +37,7 @@ resources:
       endpoint: nanoframework
 
 pool:
-  vmImage: 'windows-2019'
+  vmImage: 'windows-latest'
 
 variables:
   DOTNET_NOLOGO: true