FiftyOne.DeviceDetection.Shared 4.4.248

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package FiftyOne.DeviceDetection.Shared --version 4.4.248
                    
NuGet\Install-Package FiftyOne.DeviceDetection.Shared -Version 4.4.248
                    
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.Shared" Version="4.4.248" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FiftyOne.DeviceDetection.Shared" Version="4.4.248" />
                    
Directory.Packages.props
<PackageReference Include="FiftyOne.DeviceDetection.Shared" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add FiftyOne.DeviceDetection.Shared --version 4.4.248
                    
#r "nuget: FiftyOne.DeviceDetection.Shared, 4.4.248"
                    
#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.
#addin nuget:?package=FiftyOne.DeviceDetection.Shared&version=4.4.248
                    
Install FiftyOne.DeviceDetection.Shared as a Cake Addin
#tool nuget:?package=FiftyOne.DeviceDetection.Shared&version=4.4.248
                    
Install FiftyOne.DeviceDetection.Shared as a Cake Tool

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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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 (3)

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

Package Downloads
FiftyOne.DeviceDetection.Hash.Engine.OnPremise

51Degrees Device Detection parses HTTP headers to return detailed hardware, operating system, browser, and crawler information for the devices used to access your website or service. This package is an implementation of the device detection hash engine. CMake is used to build the native binaries.

FiftyOne.DeviceDetection.Cloud

51Degrees Device Detection parses HTTP headers to return detailed hardware, operating system, browser, and crawler information for the devices used to access your website or service. This package retrieves device detection results by consuming the 51Degrees cloud service.

FiftyOne.DeviceDetection.Pattern.Engine.OnPremise

The 51Degrees Pipeline API provides a fast, modern architecture for consuming real-time digital data services. Device detection will tell detailed properties about the hardware and software of devices that are being used to access your website or service. The 'Pattern' algorithm is designed for flexibility and accuracy over other considerations.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.5.0-alpha.155 107 6/18/2025
4.5.0-alpha.154 132 6/14/2025
4.5.0-alpha.153 121 6/4/2025
4.5.0-alpha.152 120 5/28/2025
4.5.0-alpha.151 117 5/22/2025
4.5.0-alpha.150 117 5/20/2025
4.5.0-alpha.149 207 5/13/2025
4.5.0-alpha.148 44 5/10/2025
4.5.0-alpha.147 106 5/9/2025
4.5.0-alpha.146 119 5/8/2025
4.5.0-alpha.144 120 5/7/2025
4.5.0-alpha.142 121 5/5/2025
4.5.0-alpha.131 167 4/15/2025
4.5.0-alpha.128 143 4/3/2025
4.5.0-alpha.127 129 4/3/2025
4.5.0-alpha.126 126 4/2/2025
4.5.0-alpha.125 2,636 4/1/2025
4.5.0-alpha.124 109 3/28/2025
4.5.0-alpha.123 99 3/27/2025
4.5.0-alpha.122 441 3/26/2025
4.5.0-alpha.121 106 3/21/2025
4.5.0-alpha.120 116 3/18/2025
4.5.0-alpha.119 139 3/11/2025
4.5.0-alpha.118 168 3/7/2025
4.5.0-alpha.117 188 3/6/2025
4.5.0-alpha.116 172 3/4/2025
4.5.0-alpha.115 65 2/27/2025
4.5.0-alpha.114 62 2/27/2025
4.5.0-alpha.112 64 2/25/2025
4.5.0-alpha.111 71 2/21/2025
4.5.0-alpha.110 89 2/18/2025
4.5.0-alpha.109 76 2/14/2025
4.5.0-alpha.108 74 2/12/2025
4.5.0-alpha.107 72 2/11/2025
4.5.0-alpha.106 74 2/9/2025
4.5.0-alpha.105 70 2/8/2025
4.5.0-alpha.104 64 2/7/2025
4.5.0-alpha.103 61 2/6/2025
4.5.0-alpha.102 70 2/6/2025
4.5.0-alpha.101 77 2/4/2025
4.5.0-alpha.99 2,355 1/30/2025
4.5.0-alpha.98 98 1/29/2025
4.5.0-alpha.97 150 1/26/2025
4.5.0-alpha.96 87 1/25/2025
4.5.0-alpha.94 87 1/24/2025
4.5.0-alpha.92 62 1/23/2025
4.5.0-alpha.91 58 1/22/2025
4.5.0-alpha.84 177 1/15/2025
4.5.0-alpha.83 50 1/14/2025
4.5.0-alpha.81 2,001 1/14/2025
4.5.0-alpha.79 68 1/12/2025
4.5.0-alpha.77 138 1/9/2025
4.5.0-alpha.75 52 1/8/2025
4.5.0-alpha.73 231 1/3/2025
4.5.0-alpha.71 65 12/31/2024
4.5.0-alpha.67 446 12/24/2024
4.5.0-alpha.65 63 12/23/2024
4.5.0-alpha.61 82 12/21/2024
4.5.0-alpha.59 67 12/20/2024
4.5.0-alpha.57 108 12/18/2024
4.5.0-alpha.53 68 12/16/2024
4.5.0-alpha.51 65 12/16/2024
4.5.0-alpha.50 72 12/16/2024
4.5.0-alpha.43 67 12/2/2024
4.5.0-alpha.32 78 11/14/2024
4.5.0-alpha.30 64 11/13/2024
4.5.0-alpha.28 66 11/12/2024
4.5.0-alpha.26 62 11/9/2024
4.5.0-alpha.24 69 11/7/2024
4.5.0-alpha.22 53 11/6/2024
4.5.0-alpha.18 69 11/5/2024
4.5.0-alpha.14 96 10/15/2024
4.5.0-alpha.12 61 10/14/2024
4.5.0-alpha.11 64 10/13/2024
4.5.0-alpha.9 65 10/10/2024
4.4.248 2,630 4/15/2025
4.4.247 816 4/4/2025
4.4.246 273 4/3/2025
4.4.245 277 4/2/2025
4.4.244 259 4/1/2025
4.4.243 826 3/18/2025
4.4.242 239 3/15/2025
4.4.241 363 3/12/2025
4.4.240 282 3/11/2025
4.4.239 444 3/8/2025
4.4.238 339 3/7/2025
4.4.237 546 3/4/2025
4.4.236 280 3/2/2025
4.4.235 246 3/1/2025
4.4.234 280 2/27/2025
4.4.233 188 2/27/2025
4.4.232 267 2/26/2025
4.4.231 180 2/26/2025
4.4.230 551 2/18/2025
4.4.229 431 2/12/2025
4.4.228 371 2/8/2025
4.4.227 233 2/7/2025
4.4.226 258 2/6/2025
4.4.225 169 2/6/2025
4.4.224 197 2/5/2025
4.4.223 209 2/5/2025
4.4.222 183 2/5/2025
4.4.221 295 2/4/2025
4.4.220 309 2/2/2025
4.4.219 374 1/29/2025
4.4.218 397 1/26/2025
4.4.217 353 1/22/2025
4.4.216 290 1/20/2025
4.4.215 258 1/18/2025
4.4.214 274 1/16/2025
4.4.213 878 1/15/2025
4.4.212 645 1/9/2025
4.4.211 252 1/7/2025
4.4.210 405 1/3/2025
4.4.209 299 1/2/2025
4.4.208 270 1/1/2025
4.4.207 517 12/25/2024
4.4.206 302 12/23/2024
4.4.205 310 12/21/2024
4.4.204 252 12/20/2024
4.4.203 276 12/18/2024
4.4.202 280 12/17/2024
4.4.201 831 12/16/2024
4.4.200 495 12/11/2024
4.4.199 233 12/10/2024
4.4.198 607 12/3/2024
4.4.197 281 12/2/2024
4.4.196 252 12/1/2024
4.4.195 330 11/27/2024
4.4.194 762 11/14/2024
4.4.193 238 11/13/2024
4.4.192 238 11/12/2024
4.4.191 661 11/9/2024
4.4.190 286 11/6/2024
4.4.189 335 11/5/2024
4.4.188 245 11/3/2024
4.4.187 250 11/2/2024
4.4.186 499 10/23/2024
4.4.185 234 10/22/2024
4.4.184 1,469 10/18/2024
4.4.183 290 10/17/2024
4.4.182 2,060 10/10/2024
4.4.181 289 10/8/2024
4.4.180 323 10/4/2024
4.4.179 1,111 10/2/2024
4.4.178 327 10/1/2024
4.4.177 1,112 9/30/2024
4.4.176 283 9/28/2024
4.4.175 1,217 9/13/2024
4.4.174 374 9/10/2024
4.4.173 308 9/8/2024
4.4.172 292 9/7/2024
4.4.171 312 9/5/2024
4.4.170 294 9/4/2024
4.4.169 292 9/3/2024
4.4.168 345 8/30/2024
4.4.167 273 8/29/2024
4.4.166 657 8/20/2024
4.4.165 416 8/15/2024
4.4.164 302 8/14/2024
4.4.163 392 8/13/2024
4.4.162 754 8/7/2024
4.4.161 644 8/6/2024
4.4.160 228 8/5/2024
4.4.159 215 8/3/2024
4.4.158 205 7/30/2024
4.4.157 235 7/26/2024
4.4.156 150 7/26/2024
4.4.155 307 7/24/2024
4.4.154 1,325 7/19/2024
4.4.153 270 7/18/2024
4.4.152 275 7/17/2024
4.4.151 267 7/16/2024
4.4.150 268 7/15/2024
4.4.149 434 7/11/2024
4.4.148 283 7/10/2024
4.4.147 321 7/9/2024
4.4.146 306 7/7/2024
4.4.145 330 7/4/2024
4.4.144 539 6/27/2024
4.4.143 296 6/25/2024
4.4.142 1,247 6/19/2024
4.4.141 327 6/19/2024
4.4.140 364 6/15/2024
4.4.139 332 6/11/2024
4.4.138 1,430 6/1/2024
4.4.137 282 5/31/2024
4.4.136 333 5/29/2024
4.4.135 271 5/29/2024
4.4.134 4,857 5/25/2024
4.4.133 411 5/22/2024
4.4.132 398 5/18/2024
4.4.131 466 5/17/2024
4.4.130 277 5/16/2024
4.4.129 212 5/16/2024
4.4.128 229 5/15/2024
4.4.127 209 5/15/2024
4.4.126 286 5/14/2024
4.4.125 927 5/13/2024
4.4.124 293 5/12/2024
4.4.123 219 5/12/2024
4.4.122 468 5/8/2024
4.4.121 487 5/3/2024
4.4.120 223 5/2/2024
4.4.119 316 4/30/2024
4.4.118 440 4/28/2024
4.4.117 588 4/25/2024
4.4.116 446 4/23/2024
4.4.115 370 4/21/2024
4.4.114 346 4/20/2024
4.4.113 5,982 4/10/2024
4.4.112 320 4/4/2024
4.4.111 888 3/27/2024
4.4.110 2,217 3/21/2024
4.4.109 344 3/21/2024
4.4.108 495 3/19/2024
4.4.107 393 3/18/2024
4.4.106 381 3/17/2024
4.4.105 382 3/16/2024
4.4.104 1,330 2/22/2024
4.4.103 517 2/21/2024
4.4.102 619 2/16/2024
4.4.101 601 2/15/2024
4.4.100 586 2/14/2024
4.4.99 547 2/14/2024
4.4.98 879 2/2/2024
4.4.97 890 2/1/2024
4.4.96 2,552 1/28/2024
4.4.95 597 1/27/2024
4.4.94 584 1/26/2024
4.4.93 1,047 1/18/2024
4.4.92 616 1/16/2024
4.4.91 639 1/14/2024
4.4.90 605 1/13/2024
4.4.89 609 1/12/2024
4.4.88 628 1/11/2024
4.4.87 638 1/10/2024
4.4.86 700 1/7/2024
4.4.85 1,216 12/21/2023
4.4.84 635 12/19/2023
4.4.83 825 12/8/2023
4.4.82 697 12/3/2023
4.4.81 639 12/1/2023
4.4.80 628 11/30/2023
4.4.79 634 11/29/2023
4.4.78 653 11/26/2023
4.4.77 661 11/25/2023
4.4.76 642 11/24/2023
4.4.75 623 11/23/2023
4.4.74 663 11/21/2023
4.4.73 862 11/4/2023
4.4.72 584 11/3/2023
4.4.71 617 11/2/2023
4.4.70 589 11/1/2023
4.4.69 690 10/29/2023
4.4.68 614 10/28/2023
4.4.67 606 10/27/2023
4.4.66 614 10/26/2023
4.4.65 664 10/25/2023
4.4.64 2,202 10/12/2023
4.4.63 2,141 10/6/2023
4.4.62 1,413 9/24/2023
4.4.61 665 9/21/2023
4.4.60 598 9/21/2023
4.4.59 826 9/17/2023
4.4.58 601 9/16/2023
4.4.57 649 9/15/2023
4.4.56 691 9/14/2023
4.4.55 613 9/13/2023
4.4.54 739 9/11/2023
4.4.53 620 9/10/2023
4.4.52 623 9/9/2023
4.4.51 710 9/6/2023
4.4.50 652 9/3/2023
4.4.49 662 9/1/2023
4.4.48 770 8/31/2023
4.4.47 1,229 8/18/2023
4.4.46 847 8/11/2023
4.4.45 729 8/10/2023
4.4.44 675 8/8/2023
4.4.43 8,228 7/22/2023
4.4.42 680 7/20/2023
4.4.41 696 7/17/2023
4.4.40 682 7/15/2023
4.4.39 724 7/13/2023
4.4.38 776 7/9/2023
4.4.37 724 7/6/2023
4.4.36 706 7/4/2023
4.4.35 1,038 6/28/2023
4.4.34 723 6/27/2023
4.4.33 1,708 6/24/2023
4.4.32 1,246 6/22/2023
4.4.31 1,591 6/21/2023
4.4.30 755 6/20/2023
4.4.29 811 6/15/2023
4.4.28 716 6/14/2023
4.4.27 814 6/12/2023
4.4.26 772 6/10/2023
4.4.25 880 6/8/2023
4.4.24 5,055 6/5/2023
4.4.23 25,890 3/24/2023
4.4.22 1,879 3/20/2023
4.4.21 1,194 3/15/2023
4.4.20 1,025 3/10/2023
4.4.19 1,227 3/6/2023
4.4.17 4,456 2/15/2023
4.4.16 6,771 2/1/2023
4.4.15 1,500 1/18/2023
4.4.14 2,618 12/8/2022
4.4.13 2,134 12/7/2022
4.4.12 3,425 11/2/2022
4.4.11 1,783 8/30/2022
4.4.10 2,988 8/10/2022
4.4.9 1,928 7/27/2022
4.4.8 284,691 6/29/2022
4.4.7 1,648 6/22/2022
4.4.6 1,632 6/15/2022
4.4.5 1,822 5/25/2022
4.4.3 2,014 5/4/2022
4.4.2 1,957 4/27/2022
4.4.1 1,864 4/20/2022
4.4.0 2,094 4/7/2022
4.3.17 3,597 3/31/2022
4.3.16 2,367 3/2/2022
4.3.15 4,185 2/2/2022
4.3.14 1,985 1/25/2022
4.3.13 15,769 12/22/2021
4.3.12 1,374 12/15/2021
4.3.11 1,329 12/1/2021
4.3.10 1,455 11/17/2021
4.3.9 1,783 11/3/2021
4.3.8 1,537 10/6/2021
4.3.6 952 9/15/2021
4.3.5 184 9/1/2021
4.3.4 716 8/17/2021
4.3.3 248 8/3/2021
4.3.0 588 6/16/2021
4.2.4 2,562 5/11/2021
4.2.1 1,720 2/3/2021
4.2.0 1,594 1/6/2021
4.1.10 2,715 8/10/2020
4.1.8 356 7/13/2020
4.1.7 578 6/30/2020
4.1.6 1,986 5/29/2020
4.1.0-beta.26 315 2/18/2020
4.1.0-beta.25 245 2/13/2020
4.1.0-beta.19 283 1/7/2020
4.1.0-beta.18 311 1/7/2020