FiftyOne.DeviceDetection 4.5.0-alpha.59

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.59                
NuGet\Install-Package FiftyOne.DeviceDetection -Version 4.5.0-alpha.59                
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.59" />                
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.59                
#r "nuget: FiftyOne.DeviceDetection, 4.5.0-alpha.59"                
#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.59&prerelease

// Install FiftyOne.DeviceDetection as a Cake Tool
#tool nuget:?package=FiftyOne.DeviceDetection&version=4.5.0-alpha.59&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. 
.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.67 0 12/24/2024
4.5.0-alpha.65 4 12/23/2024
4.5.0-alpha.61 50 12/21/2024
4.5.0-alpha.59 45 12/20/2024
4.5.0-alpha.57 65 12/18/2024
4.5.0-alpha.53 44 12/16/2024
4.5.0-alpha.51 33 12/16/2024
4.5.0-alpha.50 37 12/16/2024
4.5.0-alpha.43 46 12/2/2024
4.5.0-alpha.32 56 11/14/2024
4.5.0-alpha.30 49 11/13/2024
4.5.0-alpha.28 44 11/12/2024
4.5.0-alpha.26 46 11/9/2024
4.5.0-alpha.24 39 11/7/2024
4.5.0-alpha.22 35 11/6/2024
4.5.0-alpha.18 44 11/5/2024
4.5.0-alpha.14 77 10/15/2024
4.5.0-alpha.12 43 10/14/2024
4.5.0-alpha.11 43 10/13/2024
4.5.0-alpha.9 54 10/10/2024
4.4.206 12 12/23/2024
4.4.205 150 12/21/2024
4.4.204 128 12/20/2024
4.4.203 156 12/18/2024
4.4.202 148 12/17/2024
4.4.201 134 12/16/2024
4.4.200 332 12/11/2024
4.4.199 126 12/10/2024
4.4.198 412 12/3/2024
4.4.197 182 12/2/2024
4.4.196 129 12/1/2024
4.4.195 227 11/27/2024
4.4.194 591 11/14/2024
4.4.193 122 11/13/2024
4.4.192 133 11/12/2024
4.4.191 288 11/9/2024
4.4.190 180 11/6/2024
4.4.189 178 11/5/2024
4.4.188 140 11/3/2024
4.4.187 142 11/2/2024
4.4.186 362 10/23/2024
4.4.185 119 10/22/2024
4.4.184 635 10/18/2024
4.4.183 181 10/17/2024
4.4.182 973 10/10/2024
4.4.181 181 10/8/2024
4.4.180 228 10/4/2024
4.4.179 502 10/2/2024
4.4.178 165 10/1/2024
4.4.177 576 9/30/2024
4.4.176 172 9/28/2024
4.4.175 803 9/13/2024
4.4.174 210 9/10/2024
4.4.173 161 9/8/2024
4.4.172 143 9/7/2024
4.4.171 171 9/5/2024
4.4.170 151 9/4/2024
4.4.169 154 9/3/2024
4.4.168 210 8/30/2024
4.4.167 139 8/29/2024
4.4.166 497 8/20/2024
4.4.165 286 8/15/2024
4.4.164 149 8/14/2024
4.4.163 249 8/13/2024
4.4.162 1,017 8/7/2024
4.4.161 462 8/6/2024
4.4.160 111 8/5/2024
4.4.159 101 8/3/2024
4.4.158 129 7/30/2024
4.4.157 174 7/26/2024
4.4.156 78 7/26/2024
4.4.155 203 7/24/2024
4.4.154 549 7/19/2024
4.4.153 152 7/18/2024
4.4.152 140 7/17/2024
4.4.151 142 7/16/2024
4.4.150 129 7/15/2024
4.4.149 238 7/11/2024
4.4.148 162 7/10/2024
4.4.147 151 7/9/2024
4.4.146 180 7/7/2024
4.4.145 222 7/4/2024
4.4.144 382 6/27/2024
4.4.143 169 6/25/2024
4.4.142 735 6/19/2024
4.4.141 172 6/19/2024
4.4.140 227 6/15/2024
4.4.139 209 6/11/2024
4.4.138 830 6/1/2024
4.4.137 163 5/31/2024
4.4.136 210 5/29/2024
4.4.135 126 5/29/2024
4.4.134 1,170 5/25/2024
4.4.133 232 5/22/2024
4.4.132 238 5/18/2024
4.4.131 130 5/17/2024
4.4.130 138 5/16/2024
4.4.129 98 5/16/2024
4.4.128 124 5/15/2024
4.4.127 115 5/15/2024
4.4.126 185 5/14/2024
4.4.125 506 5/13/2024
4.4.124 237 5/12/2024
4.4.123 116 5/12/2024
4.4.122 289 5/8/2024
4.4.121 289 5/3/2024
4.4.120 82 5/2/2024
4.4.119 166 4/30/2024
4.4.118 319 4/28/2024
4.4.117 210 4/25/2024
4.4.116 255 4/23/2024
4.4.115 214 4/21/2024
4.4.114 190 4/20/2024
4.4.113 5,397 4/10/2024
4.4.112 162 4/4/2024
4.4.111 537 3/27/2024
4.4.110 1,353 3/21/2024
4.4.109 182 3/21/2024
4.4.108 237 3/19/2024
4.4.107 189 3/18/2024
4.4.106 184 3/17/2024
4.4.105 175 3/16/2024
4.4.104 1,067 2/22/2024
4.4.103 266 2/21/2024
4.4.102 332 2/16/2024
4.4.101 262 2/15/2024
4.4.100 286 2/14/2024
4.4.99 245 2/14/2024
4.4.98 553 2/2/2024
4.4.97 293 2/1/2024
4.4.96 2,202 1/28/2024
4.4.95 257 1/27/2024
4.4.94 278 1/26/2024
4.4.93 673 1/18/2024
4.4.92 299 1/16/2024
4.4.91 310 1/14/2024
4.4.90 291 1/13/2024
4.4.89 266 1/12/2024
4.4.88 287 1/11/2024
4.4.87 269 1/10/2024
4.4.86 390 1/7/2024
4.4.85 1,098 12/21/2023
4.4.84 283 12/19/2023
4.4.83 518 12/8/2023
4.4.82 363 12/3/2023
4.4.81 306 12/1/2023
4.4.80 297 11/30/2023
4.4.79 314 11/29/2023
4.4.78 321 11/26/2023
4.4.77 281 11/25/2023
4.4.76 314 11/24/2023
4.4.75 301 11/23/2023
4.4.74 321 11/21/2023
4.4.73 544 11/4/2023
4.4.72 267 11/3/2023
4.4.71 289 11/2/2023
4.4.70 258 11/1/2023
4.4.69 379 10/29/2023
4.4.68 292 10/28/2023
4.4.67 279 10/27/2023
4.4.66 292 10/26/2023
4.4.65 326 10/25/2023
4.4.64 1,846 10/12/2023
4.4.63 429 10/6/2023
4.4.62 830 9/24/2023
4.4.61 349 9/21/2023
4.4.60 269 9/21/2023
4.4.59 507 9/17/2023
4.4.58 285 9/16/2023
4.4.57 309 9/15/2023
4.4.56 315 9/14/2023
4.4.55 313 9/13/2023
4.4.54 415 9/11/2023
4.4.53 306 9/10/2023
4.4.52 292 9/9/2023
4.4.51 369 9/6/2023
4.4.50 352 9/3/2023
4.4.49 334 9/1/2023
4.4.48 368 8/31/2023
4.4.47 585 8/18/2023
4.4.46 464 8/11/2023
4.4.45 363 8/10/2023
4.4.44 325 8/8/2023
4.4.43 7,152 7/22/2023
4.4.42 359 7/20/2023
4.4.41 353 7/17/2023
4.4.40 304 7/15/2023
4.4.39 362 7/13/2023
4.4.38 408 7/9/2023
4.4.37 369 7/6/2023
4.4.36 345 7/4/2023
4.4.35 411 6/28/2023
4.4.34 331 6/27/2023
4.4.33 1,153 6/24/2023
4.4.32 824 6/22/2023
4.4.31 1,184 6/21/2023
4.4.30 362 6/20/2023
4.4.29 417 6/15/2023
4.4.28 341 6/14/2023
4.4.27 370 6/12/2023
4.4.26 354 6/10/2023
4.4.25 438 6/8/2023
4.4.24 2,660 6/5/2023
4.4.23 18,491 3/24/2023
4.4.22 1,730 3/20/2023
4.4.21 616 3/15/2023
4.4.20 460 3/10/2023
4.4.19 636 3/6/2023
4.4.17 3,545 2/15/2023
4.4.16 4,789 2/1/2023
4.4.15 744 1/18/2023
4.4.14 1,524 12/8/2022
4.4.13 1,334 12/7/2022
4.4.12 1,995 11/2/2022
4.4.11 789 8/30/2022
4.4.10 1,768 8/10/2022
4.4.9 893 7/27/2022
4.4.8 231,955 6/29/2022
4.4.7 634 6/22/2022
4.4.6 600 6/15/2022
4.4.5 595 5/25/2022
4.4.3 852 5/4/2022
4.4.2 595 4/27/2022
4.4.1 608 4/20/2022
4.4.0 640 4/7/2022
4.3.17 1,333 3/31/2022 4.3.17 is deprecated because it is no longer maintained.
4.3.16 1,325 3/2/2022 4.3.16 is deprecated because it is no longer maintained.
4.3.15 3,084 2/2/2022 4.3.15 is deprecated because it is no longer maintained.
4.3.14 927 1/25/2022 4.3.14 is deprecated because it is no longer maintained.
4.3.13 14,224 12/22/2021 4.3.13 is deprecated because it is no longer maintained.
4.3.12 628 12/15/2021 4.3.12 is deprecated because it is no longer maintained.
4.3.11 593 12/1/2021 4.3.11 is deprecated because it is no longer maintained.
4.3.10 599 11/17/2021 4.3.10 is deprecated because it is no longer maintained.
4.3.9 985 11/3/2021 4.3.9 is deprecated because it is no longer maintained.
4.3.8 728 10/6/2021 4.3.8 is deprecated because it is no longer maintained.
4.3.6 884 9/15/2021 4.3.6 is deprecated because it is no longer maintained.
4.3.5 197 9/1/2021 4.3.5 is deprecated because it is no longer maintained.
4.3.4 699 8/17/2021 4.3.4 is deprecated because it is no longer maintained.
4.3.3 234 8/3/2021 4.3.3 is deprecated because it is no longer maintained.
4.3.0 540 6/16/2021 4.3.0 is deprecated because it is no longer maintained.
4.2.4 2,411 5/11/2021 4.2.4 is deprecated because it is no longer maintained.
4.2.1 1,622 2/3/2021 4.2.1 is deprecated because it is no longer maintained.
4.2.0 734 1/6/2021 4.2.0 is deprecated because it is no longer maintained.
4.1.10 1,778 8/10/2020 4.1.10 is deprecated because it is no longer maintained.
4.1.8 339 7/13/2020 4.1.8 is deprecated because it is no longer maintained.
4.1.7 571 6/30/2020 4.1.7 is deprecated because it is no longer maintained.
4.1.6 1,955 5/29/2020 4.1.6 is deprecated because it is no longer maintained.
4.1.0-beta.26 317 2/18/2020 4.1.0-beta.26 is deprecated because it is no longer maintained.
4.1.0-beta.25 242 2/13/2020 4.1.0-beta.25 is deprecated because it is no longer maintained.
4.1.0-beta.22 300 1/17/2020 4.1.0-beta.22 is deprecated because it is no longer maintained.
4.1.0-beta.19 287 1/7/2020 4.1.0-beta.19 is deprecated because it is no longer maintained.
4.1.0-beta.18 301 1/7/2020 4.1.0-beta.18 is deprecated because it is no longer maintained.