FiftyOne.DeviceDetection.Hash.Engine.OnPremise 4.4.205

There is a newer version of this package available.
See the version list below for details.
dotnet add package FiftyOne.DeviceDetection.Hash.Engine.OnPremise --version 4.4.205                
NuGet\Install-Package FiftyOne.DeviceDetection.Hash.Engine.OnPremise -Version 4.4.205                
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.Hash.Engine.OnPremise" Version="4.4.205" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FiftyOne.DeviceDetection.Hash.Engine.OnPremise --version 4.4.205                
#r "nuget: FiftyOne.DeviceDetection.Hash.Engine.OnPremise, 4.4.205"                
#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.Hash.Engine.OnPremise as a Cake Addin
#addin nuget:?package=FiftyOne.DeviceDetection.Hash.Engine.OnPremise&version=4.4.205

// Install FiftyOne.DeviceDetection.Hash.Engine.OnPremise as a Cake Tool
#tool nuget:?package=FiftyOne.DeviceDetection.Hash.Engine.OnPremise&version=4.4.205                

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.Hash.Engine.OnPremise:

Package Downloads
FiftyOne.DeviceDetection

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 is an alternative to popular UAParser, DeviceAtlas, and WURFL packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.5.0-alpha.111 50 2 days ago
4.5.0-alpha.110 57 6 days ago
4.5.0-alpha.109 38 10 days ago
4.5.0-alpha.108 45 12 days ago
4.5.0-alpha.107 31 13 days ago
4.5.0-alpha.106 39 15 days ago
4.5.0-alpha.105 39 16 days ago
4.5.0-alpha.104 17 17 days ago
4.5.0-alpha.103 16 17 days ago
4.5.0-alpha.102 40 18 days ago
4.5.0-alpha.101 46 20 days ago
4.5.0-alpha.99 454 24 days ago
4.5.0-alpha.98 57 a month ago
4.5.0-alpha.97 117 a month ago
4.5.0-alpha.96 57 a month ago
4.5.0-alpha.94 46 a month ago
4.5.0-alpha.92 41 a month ago
4.5.0-alpha.91 40 a month ago
4.5.0-alpha.84 140 a month ago
4.5.0-alpha.83 29 a month ago
4.5.0-alpha.81 635 a month ago
4.5.0-alpha.79 51 a month ago
4.5.0-alpha.77 111 a month ago
4.5.0-alpha.75 28 2 months ago
4.5.0-alpha.73 202 2 months ago
4.5.0-alpha.71 51 2 months ago
4.5.0-alpha.67 157 2 months ago
4.5.0-alpha.65 52 2 months ago
4.5.0-alpha.61 63 2 months ago
4.5.0-alpha.59 58 2 months ago
4.5.0-alpha.57 91 2 months ago
4.5.0-alpha.53 56 2 months ago
4.5.0-alpha.51 46 2 months ago
4.5.0-alpha.50 54 2 months ago
4.5.0-alpha.43 58 3 months ago
4.5.0-alpha.32 75 3 months ago
4.5.0-alpha.30 61 3 months ago
4.5.0-alpha.28 58 3 months ago
4.5.0-alpha.26 59 3 months ago
4.5.0-alpha.24 53 4 months ago
4.5.0-alpha.22 57 4 months ago
4.5.0-alpha.18 54 4 months ago
4.5.0-alpha.14 91 4 months ago
4.5.0-alpha.12 54 4 months ago
4.5.0-alpha.11 53 4 months ago
4.5.0-alpha.9 61 4 months ago
4.4.230 305 6 days ago
4.4.229 350 12 days ago
4.4.228 288 16 days ago
4.4.227 124 17 days ago
4.4.226 131 17 days ago
4.4.223 108 18 days ago
4.4.222 111 19 days ago
4.4.221 187 20 days ago
4.4.220 197 22 days ago
4.4.219 205 a month ago
4.4.218 263 a month ago
4.4.217 253 a month ago
4.4.216 202 a month ago
4.4.215 177 a month ago
4.4.214 213 a month ago
4.4.213 236 a month ago
4.4.212 401 a month ago
4.4.211 123 2 months ago
4.4.210 322 2 months ago
4.4.209 223 2 months ago
4.4.208 177 2 months ago
4.4.207 422 2 months ago
4.4.206 227 2 months ago
4.4.205 236 2 months ago
4.4.204 179 2 months ago
4.4.203 225 2 months ago
4.4.202 208 2 months ago
4.4.201 559 2 months ago
4.4.200 415 2 months ago
4.4.199 175 2 months ago
4.4.198 469 3 months ago
4.4.197 214 3 months ago
4.4.196 174 3 months ago
4.4.195 276 3 months ago
4.4.194 643 3 months ago
4.4.193 164 3 months ago
4.4.192 156 3 months ago
4.4.191 436 3 months ago
4.4.190 228 4 months ago
4.4.189 260 4 months ago
4.4.188 188 4 months ago
4.4.187 185 4 months ago
4.4.186 410 4 months ago
4.4.185 157 4 months ago
4.4.184 1,062 4 months ago
4.4.183 220 4 months ago
4.4.182 1,312 4 months ago
4.4.181 215 5 months ago
4.4.180 261 5 months ago
4.4.179 704 5 months ago
4.4.178 211 5 months ago
4.4.177 748 5 months ago
4.4.176 209 5 months ago
4.4.175 961 5 months ago
4.4.174 270 5 months ago
4.4.173 212 6 months ago
4.4.172 181 6 months ago
4.4.171 208 6 months ago
4.4.170 215 6 months ago
4.4.169 201 6 months ago
4.4.168 275 6 months ago
4.4.167 192 6 months ago
4.4.166 549 6 months ago
4.4.165 331 6 months ago
4.4.164 188 6 months ago
4.4.163 297 6 months ago
4.4.162 670 7 months ago
4.4.161 548 7 months ago
4.4.160 153 7 months ago
4.4.159 141 7 months ago
4.4.158 148 7 months ago
4.4.157 194 7 months ago
4.4.156 98 7 months ago
4.4.155 224 7 months ago
4.4.154 905 7 months ago
4.4.153 184 7 months ago
4.4.152 191 7 months ago
4.4.151 187 7 months ago
4.4.150 182 7 months ago
4.4.149 322 7 months ago
4.4.148 192 7 months ago
4.4.147 191 7 months ago
4.4.146 232 8 months ago
4.4.145 253 8 months ago
4.4.144 433 8 months ago
4.4.143 222 8 months ago
4.4.142 766 8 months ago
4.4.141 227 8 months ago
4.4.140 293 8 months ago
4.4.139 248 8 months ago
4.4.138 972 9 months ago
4.4.137 189 9 months ago
4.4.136 245 9 months ago
4.4.135 185 9 months ago
4.4.134 1,311 9 months ago
4.4.133 285 9 months ago
4.4.132 283 9 months ago
4.4.131 168 9 months ago
4.4.130 162 9 months ago
4.4.129 137 9 months ago
4.4.128 136 9 months ago
4.4.127 129 9 months ago
4.4.126 196 9 months ago
4.4.125 684 9 months ago
4.4.124 208 9 months ago
4.4.123 148 9 months ago
4.4.122 342 10 months ago
4.4.121 337 10 months ago
4.4.120 135 10 months ago
4.4.119 220 10 months ago
4.4.118 376 10 months ago
4.4.117 448 4/25/2024
4.4.116 328 4/23/2024
4.4.115 269 4/21/2024
4.4.114 265 4/20/2024
4.4.113 5,391 4/10/2024
4.4.112 227 4/4/2024
4.4.111 626 3/27/2024
4.4.110 1,712 3/21/2024
4.4.109 238 3/21/2024
4.4.108 304 3/19/2024
4.4.107 234 3/18/2024
4.4.106 244 3/17/2024
4.4.105 228 3/16/2024
4.4.104 1,152 2/22/2024
4.4.103 327 2/21/2024
4.4.102 402 2/16/2024
4.4.101 333 2/15/2024
4.4.100 373 2/14/2024
4.4.99 313 2/14/2024
4.4.98 615 2/2/2024
4.4.97 343 2/1/2024
4.4.96 2,282 1/28/2024
4.4.95 323 1/27/2024
4.4.94 326 1/26/2024
4.4.93 718 1/18/2024
4.4.92 346 1/16/2024
4.4.91 361 1/14/2024
4.4.90 352 1/13/2024
4.4.89 330 1/12/2024
4.4.88 341 1/11/2024
4.4.87 337 1/10/2024
4.4.86 448 1/7/2024
4.4.85 925 12/21/2023
4.4.84 333 12/19/2023
4.4.83 584 12/8/2023
4.4.82 437 12/3/2023
4.4.81 370 12/1/2023
4.4.80 377 11/30/2023
4.4.79 366 11/29/2023
4.4.78 402 11/26/2023
4.4.77 358 11/25/2023
4.4.76 371 11/24/2023
4.4.75 354 11/23/2023
4.4.74 387 11/21/2023
4.4.73 603 11/4/2023
4.4.72 320 11/3/2023
4.4.71 343 11/2/2023
4.4.70 305 11/1/2023
4.4.69 442 10/29/2023
4.4.68 340 10/28/2023
4.4.67 337 10/27/2023
4.4.66 344 10/26/2023
4.4.65 397 10/25/2023
4.4.64 1,898 10/12/2023
4.4.63 1,879 10/6/2023
4.4.62 1,006 9/24/2023
4.4.61 386 9/21/2023
4.4.60 328 9/21/2023
4.4.59 578 9/17/2023
4.4.58 333 9/16/2023
4.4.57 384 9/15/2023
4.4.56 376 9/14/2023
4.4.55 361 9/13/2023
4.4.54 459 9/11/2023
4.4.53 353 9/10/2023
4.4.52 368 9/9/2023
4.4.51 436 9/6/2023
4.4.50 420 9/3/2023
4.4.49 385 9/1/2023
4.4.48 421 8/31/2023
4.4.47 726 8/18/2023
4.4.46 544 8/11/2023
4.4.45 411 8/10/2023
4.4.44 380 8/8/2023
4.4.43 7,814 7/22/2023
4.4.42 407 7/20/2023
4.4.41 407 7/17/2023
4.4.40 391 7/15/2023
4.4.39 415 7/13/2023
4.4.38 478 7/9/2023
4.4.37 430 7/6/2023
4.4.36 409 7/4/2023
4.4.35 524 6/28/2023
4.4.34 422 6/27/2023
4.4.33 1,341 6/24/2023
4.4.32 957 6/22/2023
4.4.31 1,309 6/21/2023
4.4.30 444 6/20/2023
4.4.29 501 6/15/2023
4.4.28 398 6/14/2023
4.4.27 464 6/12/2023
4.4.26 441 6/10/2023
4.4.25 566 6/8/2023
4.4.24 3,281 6/5/2023
4.4.23 22,361 3/24/2023
4.4.22 1,728 3/20/2023
4.4.21 776 3/15/2023
4.4.20 581 3/10/2023
4.4.19 818 3/6/2023
4.4.17 4,037 2/15/2023
4.4.16 5,831 2/1/2023
4.4.15 941 1/18/2023
4.4.14 1,778 12/8/2022
4.4.13 1,559 12/7/2022
4.4.12 2,325 11/2/2022
4.4.11 1,097 8/30/2022
4.4.10 2,124 8/10/2022
4.4.9 1,200 7/27/2022
4.4.8 247,388 6/29/2022
4.4.7 919 6/22/2022
4.4.6 905 6/15/2022
4.4.5 1,067 5/25/2022
4.4.3 1,198 5/4/2022
4.4.2 864 4/27/2022
4.4.1 926 4/20/2022
4.4.0 1,319 4/7/2022
4.3.17 1,650 3/31/2022 4.3.17 is deprecated because it is no longer maintained.
4.3.16 1,629 3/2/2022 4.3.16 is deprecated because it is no longer maintained.
4.3.15 3,447 2/2/2022 4.3.15 is deprecated because it is no longer maintained.
4.3.14 1,274 1/25/2022 4.3.14 is deprecated because it is no longer maintained.
4.3.13 14,632 12/22/2021 4.3.13 is deprecated because it is no longer maintained.
4.3.12 864 12/15/2021 4.3.12 is deprecated because it is no longer maintained.
4.3.11 837 12/1/2021 4.3.11 is deprecated because it is no longer maintained.
4.3.10 846 11/17/2021 4.3.10 is deprecated because it is no longer maintained.
4.3.9 1,231 11/3/2021 4.3.9 is deprecated because it is no longer maintained.
4.3.8 999 10/6/2021 4.3.8 is deprecated because it is no longer maintained.
4.3.6 927 9/15/2021 4.3.6 is deprecated because it is no longer maintained.
4.3.5 212 9/1/2021 4.3.5 is deprecated because it is no longer maintained.
4.3.4 725 8/17/2021 4.3.4 is deprecated because it is no longer maintained.
4.3.3 251 8/3/2021 4.3.3 is deprecated because it is no longer maintained.
4.3.0 590 6/16/2021 4.3.0 is deprecated because it is no longer maintained.
4.2.4 2,457 5/11/2021 4.2.4 is deprecated because it is no longer maintained.
4.2.1 1,689 2/3/2021 4.2.1 is deprecated because it is no longer maintained.
4.2.0 984 1/6/2021 4.2.0 is deprecated because it is no longer maintained.
4.1.10 1,860 8/10/2020 4.1.10 is deprecated because it is no longer maintained.
4.1.8 357 7/13/2020 4.1.8 is deprecated because it is no longer maintained.
4.1.7 586 6/30/2020 4.1.7 is deprecated because it is no longer maintained.
4.1.6 1,949 5/29/2020 4.1.6 is deprecated because it is no longer maintained.
4.1.0-beta.26 327 2/18/2020 4.1.0-beta.26 is deprecated because it is no longer maintained.
4.1.0-beta.25 268 2/13/2020 4.1.0-beta.25 is deprecated because it is no longer maintained.
4.1.0-beta.19 312 1/7/2020 4.1.0-beta.19 is deprecated because it is no longer maintained.
4.1.0-beta.18 321 1/7/2020 4.1.0-beta.18 is deprecated because it is no longer maintained.