FiftyOne.DeviceDetection 4.5.0-alpha.81

This is a prerelease version of FiftyOne.DeviceDetection.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package FiftyOne.DeviceDetection --version 4.5.0-alpha.81                
NuGet\Install-Package FiftyOne.DeviceDetection -Version 4.5.0-alpha.81                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FiftyOne.DeviceDetection" Version="4.5.0-alpha.81" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FiftyOne.DeviceDetection --version 4.5.0-alpha.81                
#r "nuget: FiftyOne.DeviceDetection, 4.5.0-alpha.81"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install FiftyOne.DeviceDetection as a Cake Addin
#addin nuget:?package=FiftyOne.DeviceDetection&version=4.5.0-alpha.81&prerelease

// Install FiftyOne.DeviceDetection as a Cake Tool
#tool nuget:?package=FiftyOne.DeviceDetection&version=4.5.0-alpha.81&prerelease                

51Degrees Device Detection Engines

51Degrees Pipeline API

Developer Documentation

Introduction

This repository contains the device detection engines for the .NET implementation of the Pipeline API.

The specification is also available on GitHub and is recommended reading if you wish to understand the concepts and design of this API.

Dependencies

Visual Studio 2022 or later is recommended. Although Visual Studio Code can be used for working with most of the projects.

The core device detection projects are written in C and C++. The Pipeline engines are written in C# and target .NET Standard 2.0.3. Example and test projects mostly target .NET 6.0 though in some cases, projects are available targeting other frameworks.

For runtime dependencies, see our dependencies page. The ci/options.json file lists the tested and packaged .NET versions and operating systems automatic tests are performed with. The solution will likely operate with other versions.

Data

The API can either use our cloud service to get its data or it can use a local (on-premise) copy of the data.

Cloud

You will require a resource key to use the Cloud API. You can create resource keys using our configurator, see our documentation on how to use this.

On-Premise

In order to perform device detection on-premise, you will need to use a 51Degrees data file. This repository includes a free, 'lite' file in the 'device-detection-data' sub-module that has a significantly reduced set of properties. To obtain a file with a more complete set of device properties see the 51Degrees website. If you want to use the lite file, you will need to install GitLFS.

On Linux:

sudo apt-get install git-lfs
git lfs install

Then, navigate to 'device-detection-cxx/device-detection-data' and execute:

git lfs pull

Solutions and projects

  • FiftyOne.DeviceDetection - Device detection engines and related projects.
    • FiftyOne.DeviceDetection - Contains device detection engine builders.
    • FiftyOne.DeviceDetection.Cloud - A .NET engine which retrieves device detection results by consuming the 51Degrees cloud service. This can be swapped out with either the hash or pattern engines seamlessly.
    • FiftyOne.DeviceDetection.Hash.Engine.OnPremise - .NET implementation of the device detection hash engine. CMake is used to build the native binaries.
    • FiftyOne.DeviceDetection.Shared - Shared classes used by the device detection engines.

Installation

Nuget

The easiest way to install is to use NuGet to add the reference to the package:

Install-Package FiftyOne.DeviceDetection

Build from Source

Device detection on-premise uses a native binary (i.e. compiled from C code to target a specific platform/architecture). The NuGet package contains several binaries for common platforms. However, in some cases, you'll need to build the native binaries yourself for your target platform. This section explains how to do this.

Pre-requisites
  • Install C build tools:
    • Windows:
      • You will need either Visual Studio 2022 or the C++ Build Tools installed.
        • Minimum platform toolset version is v143
        • Minimum Windows SDK version is 10.0.18362.0
    • Linux/MacOS:
      • sudo apt-get install g++ make libatomic1
  • If you have not already done so, pull the git submodules that contain the native code:
    • git submodule update --init --recursive

Visual studio should now be able to build the native binaries as part of its normal build process.

Packaging

You can package a project into NuGet *.nupkg file by running a command like:

dotnet pack [Project] -o "[PackagesFolder]" /p:PackageVersion=0.0.0 -c [Configuration] /p:Platform=[Architecture]
⚠️ Notes on packaging FiftyOne.DeviceDetection.Hash.Engine.OnPremise

📝 Using AnyCPU might prevent the unmanaged (C++) code from being built into .Native.dll library. Use x86/x64/arm64 specifically.

📝 If creating cross-platform package from multiple native dlls, put all 6x FiftyOne.DeviceDetection.Hash.Engine.OnPremise.Native.dll into respective folders:

../
    macos/
        arm64/
        x64/
    linux/
        x64/
        x86/
    windows/
        x64/
        x86/

and add to the packaging command:

/p:BuiltOnCI=true

related CI scripts:

  • BuiltOnCI var:
    • [https://github.com/51Degrees/common-ci/blob/main/dotnet/build-project-core.ps1]
    • [https://github.com/51Degrees/common-ci/blob/main/dotnet/build-package-nuget.ps1]
    • [https://github.com/51Degrees/common-ci/blob/main/dotnet/build-project-framework.ps1]
    • [https://github.com/51Degrees/device-detection-dotnet/blob/main/ci/run-performance-tests-console.ps1]
  • Copying native binaries:
    • [https://github.com/51Degrees/device-detection-dotnet/blob/main/ci/build-package.ps1]
Strong naming

We currently do not strong name assemblies due to downsides for developers. The main of which is that .NET Framework on Windows enables strict loading of assemblies once an assembly is strong named. A strong-named assembly reference must exactly match the version of the loaded assembly, forcing developers to configure binding redirects when using the assembly.

If it is absolutely critical for your use case to integrate a strong-named assembly - please create a feature request issue.

Examples

Examples can be found in device-detection-dotnet-examples repository.

Tests

Tests can be found in the Tests/ folder. These can all be run from within Visual Studio or by using the dotnet test command line tool.

Some tests require additional resources to run. These will either fail or return an 'inconclusive' result if these resources are not provided.

  • Some tests require an 'Enterprise' data file. This can be obtained by purchasing a license.
    • Once available, the full path to this data file must be specified in the DEVICEDETECTIONDATAFILE environment variable.
  • Tests using the cloud service require resource keys with specific properties to be provided using environment variables:
    • The SUPER_RESOURCE_KEY environment variable should be populated with a key that includes all properties. A license is required in order to access some properties.

Project documentation

For complete documentation on the Pipeline API and associated engines, see the 51Degrees documentation site.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on FiftyOne.DeviceDetection:

Package Downloads
Foundation.SitecoreExtensions

Foundation.SitecoreExtensions

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.5.0-alpha.111 52 3 days ago
4.5.0-alpha.110 54 6 days ago
4.5.0-alpha.109 36 10 days ago
4.5.0-alpha.108 40 12 days ago
4.5.0-alpha.107 34 13 days ago
4.5.0-alpha.106 44 15 days ago
4.5.0-alpha.105 41 16 days ago
4.5.0-alpha.104 20 17 days ago
4.5.0-alpha.103 14 18 days ago
4.5.0-alpha.102 36 18 days ago
4.5.0-alpha.101 38 20 days ago
4.5.0-alpha.99 347 25 days ago
4.5.0-alpha.98 51 a month ago
4.5.0-alpha.97 83 a month ago
4.5.0-alpha.96 56 a month ago
4.5.0-alpha.94 28 a month ago
4.5.0-alpha.92 34 a month ago
4.5.0-alpha.91 39 a month ago
4.5.0-alpha.84 112 a month ago
4.5.0-alpha.83 29 a month ago
4.5.0-alpha.81 643 a month ago
4.5.0-alpha.79 51 a month ago
4.5.0-alpha.77 17 a month ago
4.5.0-alpha.75 29 2 months ago
4.5.0-alpha.73 209 2 months ago
4.5.0-alpha.71 54 2 months ago
4.5.0-alpha.67 162 2 months ago
4.5.0-alpha.65 51 2 months ago
4.5.0-alpha.61 66 2 months ago
4.5.0-alpha.59 60 2 months ago
4.5.0-alpha.57 88 2 months ago
4.5.0-alpha.53 55 2 months ago
4.5.0-alpha.51 47 2 months ago
4.5.0-alpha.50 50 2 months ago
4.5.0-alpha.43 55 3 months ago
4.5.0-alpha.32 69 3 months ago
4.5.0-alpha.30 61 3 months ago
4.5.0-alpha.28 56 3 months ago
4.5.0-alpha.26 56 3 months ago
4.5.0-alpha.24 50 4 months ago
4.5.0-alpha.22 48 4 months ago
4.5.0-alpha.18 53 4 months ago
4.5.0-alpha.14 84 4 months ago
4.5.0-alpha.12 50 4 months ago
4.5.0-alpha.11 49 4 months ago
4.5.0-alpha.9 58 4 months ago
4.4.230 287 6 days ago
4.4.229 321 12 days ago
4.4.228 258 16 days ago
4.4.227 102 17 days ago
4.4.226 75 18 days ago
4.4.225 76 18 days ago
4.4.224 75 19 days ago
4.4.223 74 19 days ago
4.4.222 77 19 days ago
4.4.221 168 20 days ago
4.4.220 173 22 days ago
4.4.219 193 a month ago
4.4.218 248 a month ago
4.4.217 216 a month ago
4.4.216 172 a month ago
4.4.215 147 a month ago
4.4.214 174 a month ago
4.4.213 207 a month ago
4.4.212 398 a month ago
4.4.211 97 2 months ago
4.4.210 288 2 months ago
4.4.209 197 2 months ago
4.4.208 145 2 months ago
4.4.207 393 2 months ago
4.4.206 190 2 months ago
4.4.205 195 2 months ago
4.4.204 160 2 months ago
4.4.203 172 2 months ago
4.4.202 165 2 months ago
4.4.201 150 2 months ago
4.4.200 393 2 months ago
4.4.199 141 2 months ago
4.4.198 429 3 months ago
4.4.197 195 3 months ago
4.4.196 144 3 months ago
4.4.195 239 3 months ago
4.4.194 617 3 months ago
4.4.193 132 3 months ago
4.4.192 143 3 months ago
4.4.191 402 3 months ago
4.4.190 191 4 months ago
4.4.189 229 4 months ago
4.4.188 150 4 months ago
4.4.187 154 4 months ago
4.4.186 373 4 months ago
4.4.185 131 4 months ago
4.4.184 1,263 4 months ago
4.4.183 188 4 months ago
4.4.182 1,298 4 months ago
4.4.181 187 5 months ago
4.4.180 235 5 months ago
4.4.179 675 5 months ago
4.4.178 188 5 months ago
4.4.177 712 5 months ago
4.4.176 178 5 months ago
4.4.175 907 5 months ago
4.4.174 213 5 months ago
4.4.173 166 6 months ago
4.4.172 148 6 months ago
4.4.171 174 6 months ago
4.4.170 154 6 months ago
4.4.169 159 6 months ago
4.4.168 227 6 months ago
4.4.167 143 6 months ago
4.4.166 502 6 months ago
4.4.165 290 6 months ago
4.4.164 153 6 months ago
4.4.163 251 6 months ago
4.4.162 1,130 7 months ago
4.4.161 638 7 months ago
4.4.160 121 7 months ago
4.4.159 103 7 months ago
4.4.158 133 7 months ago
4.4.157 178 7 months ago
4.4.156 80 7 months ago
4.4.155 205 7 months ago
4.4.154 875 7 months ago
4.4.153 162 7 months ago
4.4.152 145 7 months ago
4.4.151 149 7 months ago
4.4.150 136 7 months ago
4.4.149 243 7 months ago
4.4.148 173 7 months ago
4.4.147 158 7 months ago
4.4.146 183 8 months ago
4.4.145 225 8 months ago
4.4.144 387 8 months ago
4.4.143 174 8 months ago
4.4.142 742 8 months ago
4.4.141 175 8 months ago
4.4.140 230 8 months ago
4.4.139 214 8 months ago
4.4.138 940 9 months ago
4.4.137 167 9 months ago
4.4.136 215 9 months ago
4.4.135 129 9 months ago
4.4.134 1,406 9 months ago
4.4.133 239 9 months ago
4.4.132 243 9 months ago
4.4.131 135 9 months ago
4.4.130 141 9 months ago
4.4.129 103 9 months ago
4.4.128 129 9 months ago
4.4.127 120 9 months ago
4.4.126 188 9 months ago
4.4.125 676 9 months ago
4.4.124 349 9 months ago
4.4.123 121 9 months ago
4.4.122 295 10 months ago
4.4.121 292 10 months ago
4.4.120 85 10 months ago
4.4.119 169 10 months ago
4.4.118 322 10 months ago
4.4.117 213 4/25/2024
4.4.116 260 4/23/2024
4.4.115 217 4/21/2024
4.4.114 209 4/20/2024
4.4.113 5,532 4/10/2024
4.4.112 165 4/4/2024
4.4.111 547 3/27/2024
4.4.110 1,408 3/21/2024
4.4.109 185 3/21/2024
4.4.108 242 3/19/2024
4.4.107 192 3/18/2024
4.4.106 187 3/17/2024
4.4.105 178 3/16/2024
4.4.104 1,070 2/22/2024
4.4.103 269 2/21/2024
4.4.102 339 2/16/2024
4.4.101 270 2/15/2024
4.4.100 293 2/14/2024
4.4.99 252 2/14/2024
4.4.98 557 2/2/2024
4.4.97 312 2/1/2024
4.4.96 2,223 1/28/2024
4.4.95 260 1/27/2024
4.4.94 284 1/26/2024
4.4.93 679 1/18/2024
4.4.92 302 1/16/2024
4.4.91 313 1/14/2024
4.4.90 294 1/13/2024
4.4.89 271 1/12/2024
4.4.88 290 1/11/2024
4.4.87 272 1/10/2024
4.4.86 393 1/7/2024
4.4.85 1,116 12/21/2023
4.4.84 286 12/19/2023
4.4.83 523 12/8/2023
4.4.82 366 12/3/2023
4.4.81 309 12/1/2023
4.4.80 300 11/30/2023
4.4.79 317 11/29/2023
4.4.78 324 11/26/2023
4.4.77 284 11/25/2023
4.4.76 317 11/24/2023
4.4.75 304 11/23/2023
4.4.74 324 11/21/2023
4.4.73 549 11/4/2023
4.4.72 272 11/3/2023
4.4.71 292 11/2/2023
4.4.70 261 11/1/2023
4.4.69 384 10/29/2023
4.4.68 303 10/28/2023
4.4.67 284 10/27/2023
4.4.66 303 10/26/2023
4.4.65 329 10/25/2023
4.4.64 1,855 10/12/2023
4.4.63 434 10/6/2023
4.4.62 834 9/24/2023
4.4.61 354 9/21/2023
4.4.60 274 9/21/2023
4.4.59 513 9/17/2023
4.4.58 290 9/16/2023
4.4.57 314 9/15/2023
4.4.56 320 9/14/2023
4.4.55 318 9/13/2023
4.4.54 422 9/11/2023
4.4.53 311 9/10/2023
4.4.52 297 9/9/2023
4.4.51 380 9/6/2023
4.4.50 355 9/3/2023
4.4.49 337 9/1/2023
4.4.48 373 8/31/2023
4.4.47 688 8/18/2023
4.4.46 469 8/11/2023
4.4.45 366 8/10/2023
4.4.44 331 8/8/2023
4.4.43 7,155 7/22/2023
4.4.42 362 7/20/2023
4.4.41 358 7/17/2023
4.4.40 309 7/15/2023
4.4.39 365 7/13/2023
4.4.38 415 7/9/2023
4.4.37 372 7/6/2023
4.4.36 352 7/4/2023
4.4.35 416 6/28/2023
4.4.34 337 6/27/2023
4.4.33 1,250 6/24/2023
4.4.32 872 6/22/2023
4.4.31 1,228 6/21/2023
4.4.30 365 6/20/2023
4.4.29 420 6/15/2023
4.4.28 358 6/14/2023
4.4.27 375 6/12/2023
4.4.26 359 6/10/2023
4.4.25 450 6/8/2023
4.4.24 3,187 6/5/2023
4.4.23 19,682 3/24/2023
4.4.22 1,804 3/20/2023
4.4.21 618 3/15/2023
4.4.20 462 3/10/2023
4.4.19 657 3/6/2023
4.4.17 3,632 2/15/2023
4.4.16 4,968 2/1/2023
4.4.15 749 1/18/2023
4.4.14 1,546 12/8/2022
4.4.13 1,337 12/7/2022
4.4.12 2,084 11/2/2022
4.4.11 795 8/30/2022
4.4.10 1,852 8/10/2022
4.4.9 900 7/27/2022
4.4.8 246,996 6/29/2022
4.4.7 643 6/22/2022
4.4.6 605 6/15/2022
4.4.5 600 5/25/2022
4.4.3 857 5/4/2022
4.4.2 600 4/27/2022
4.4.1 613 4/20/2022
4.4.0 646 4/7/2022
4.3.17 1,336 3/31/2022 4.3.17 is deprecated because it is no longer maintained.
4.3.16 1,328 3/2/2022 4.3.16 is deprecated because it is no longer maintained.
4.3.15 3,087 2/2/2022 4.3.15 is deprecated because it is no longer maintained.
4.3.14 930 1/25/2022 4.3.14 is deprecated because it is no longer maintained.
4.3.13 14,341 12/22/2021 4.3.13 is deprecated because it is no longer maintained.
4.3.12 631 12/15/2021 4.3.12 is deprecated because it is no longer maintained.
4.3.11 596 12/1/2021 4.3.11 is deprecated because it is no longer maintained.
4.3.10 602 11/17/2021 4.3.10 is deprecated because it is no longer maintained.
4.3.9 990 11/3/2021 4.3.9 is deprecated because it is no longer maintained.
4.3.8 731 10/6/2021 4.3.8 is deprecated because it is no longer maintained.
4.3.6 886 9/15/2021 4.3.6 is deprecated because it is no longer maintained.
4.3.5 199 9/1/2021 4.3.5 is deprecated because it is no longer maintained.
4.3.4 703 8/17/2021 4.3.4 is deprecated because it is no longer maintained.
4.3.3 236 8/3/2021 4.3.3 is deprecated because it is no longer maintained.
4.3.0 550 6/16/2021 4.3.0 is deprecated because it is no longer maintained.
4.2.4 2,445 5/11/2021 4.2.4 is deprecated because it is no longer maintained.
4.2.1 1,695 2/3/2021 4.2.1 is deprecated because it is no longer maintained.
4.2.0 737 1/6/2021 4.2.0 is deprecated because it is no longer maintained.
4.1.10 1,781 8/10/2020 4.1.10 is deprecated because it is no longer maintained.
4.1.8 341 7/13/2020 4.1.8 is deprecated because it is no longer maintained.
4.1.7 573 6/30/2020 4.1.7 is deprecated because it is no longer maintained.
4.1.6 1,987 5/29/2020 4.1.6 is deprecated because it is no longer maintained.
4.1.0-beta.26 319 2/18/2020 4.1.0-beta.26 is deprecated because it is no longer maintained.
4.1.0-beta.25 244 2/13/2020 4.1.0-beta.25 is deprecated because it is no longer maintained.
4.1.0-beta.22 302 1/17/2020 4.1.0-beta.22 is deprecated because it is no longer maintained.
4.1.0-beta.19 289 1/7/2020 4.1.0-beta.19 is deprecated because it is no longer maintained.
4.1.0-beta.18 303 1/7/2020 4.1.0-beta.18 is deprecated because it is no longer maintained.