FiftyOne.DeviceDetection.Hash.Engine.OnPremise 4.5.0-alpha.53

This is a prerelease version of FiftyOne.DeviceDetection.Hash.Engine.OnPremise.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package FiftyOne.DeviceDetection.Hash.Engine.OnPremise --version 4.5.0-alpha.53                
NuGet\Install-Package FiftyOne.DeviceDetection.Hash.Engine.OnPremise -Version 4.5.0-alpha.53                
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.5.0-alpha.53" />                
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.5.0-alpha.53                
#r "nuget: FiftyOne.DeviceDetection.Hash.Engine.OnPremise, 4.5.0-alpha.53"                
#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.5.0-alpha.53&prerelease

// Install FiftyOne.DeviceDetection.Hash.Engine.OnPremise as a Cake Tool
#tool nuget:?package=FiftyOne.DeviceDetection.Hash.Engine.OnPremise&version=4.5.0-alpha.53&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.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.67 53 6 days ago
4.5.0-alpha.65 36 6 days ago
4.5.0-alpha.61 52 9 days ago
4.5.0-alpha.59 43 10 days ago
4.5.0-alpha.57 74 12 days ago
4.5.0-alpha.53 45 14 days ago
4.5.0-alpha.51 35 14 days ago
4.5.0-alpha.50 37 14 days ago
4.5.0-alpha.43 47 a month ago
4.5.0-alpha.32 60 2 months ago
4.5.0-alpha.30 46 2 months ago
4.5.0-alpha.28 46 2 months ago
4.5.0-alpha.26 48 2 months ago
4.5.0-alpha.24 42 2 months ago
4.5.0-alpha.22 45 2 months ago
4.5.0-alpha.18 45 2 months ago
4.5.0-alpha.14 84 2 months ago
4.5.0-alpha.12 49 2 months ago
4.5.0-alpha.11 49 3 months ago
4.5.0-alpha.9 55 3 months ago
4.4.207 241 5 days ago
4.4.206 205 6 days ago
4.4.205 217 9 days ago
4.4.204 160 10 days ago
4.4.203 208 12 days ago
4.4.202 192 13 days ago
4.4.201 237 14 days ago
4.4.200 354 19 days ago
4.4.199 161 19 days ago
4.4.198 457 a month ago
4.4.197 200 a month ago
4.4.196 160 a month ago
4.4.195 265 a month ago
4.4.194 621 2 months ago
4.4.193 153 2 months ago
4.4.192 147 2 months ago
4.4.191 331 2 months ago
4.4.190 219 2 months ago
4.4.189 231 2 months ago
4.4.188 178 2 months ago
4.4.187 176 2 months ago
4.4.186 399 2 months ago
4.4.185 148 2 months ago
4.4.184 651 2 months ago
4.4.183 213 2 months ago
4.4.182 1,001 3 months ago
4.4.181 211 3 months ago
4.4.180 255 3 months ago
4.4.179 543 3 months ago
4.4.178 188 3 months ago
4.4.177 636 3 months ago
4.4.176 203 3 months ago
4.4.175 865 4 months ago
4.4.174 268 4 months ago
4.4.173 208 4 months ago
4.4.172 177 4 months ago
4.4.171 206 4 months ago
4.4.170 202 4 months ago
4.4.169 197 4 months ago
4.4.168 260 4 months ago
4.4.167 188 4 months ago
4.4.166 545 4 months ago
4.4.165 327 4 months ago
4.4.164 184 5 months ago
4.4.163 294 5 months ago
4.4.162 668 5 months ago
4.4.161 467 5 months ago
4.4.160 151 5 months ago
4.4.159 137 5 months ago
4.4.158 142 5 months ago
4.4.157 190 5 months ago
4.4.156 94 5 months ago
4.4.155 222 5 months ago
4.4.154 594 5 months ago
4.4.153 179 5 months ago
4.4.152 187 5 months ago
4.4.151 184 5 months ago
4.4.150 177 5 months ago
4.4.149 317 6 months ago
4.4.148 183 6 months ago
4.4.147 184 6 months ago
4.4.146 225 6 months ago
4.4.145 250 6 months ago
4.4.144 428 6 months ago
4.4.143 219 6 months ago
4.4.142 759 6 months ago
4.4.141 220 6 months ago
4.4.140 288 6 months ago
4.4.139 245 7 months ago
4.4.138 872 7 months ago
4.4.137 186 7 months ago
4.4.136 240 7 months ago
4.4.135 182 7 months ago
4.4.134 1,156 7 months ago
4.4.133 278 7 months ago
4.4.132 280 7 months ago
4.4.131 163 7 months ago
4.4.130 157 7 months ago
4.4.129 132 7 months ago
4.4.128 130 7 months ago
4.4.127 124 7 months ago
4.4.126 193 8 months ago
4.4.125 522 8 months ago
4.4.124 200 8 months ago
4.4.123 143 8 months ago
4.4.122 339 8 months ago
4.4.121 334 8 months ago
4.4.120 132 8 months ago
4.4.119 217 8 months ago
4.4.118 370 8 months ago
4.4.117 432 8 months ago
4.4.116 323 8 months ago
4.4.115 266 8 months ago
4.4.114 242 8 months ago
4.4.113 5,265 9 months ago
4.4.112 224 9 months ago
4.4.111 621 9 months ago
4.4.110 1,674 9 months ago
4.4.109 235 9 months ago
4.4.108 299 9 months ago
4.4.107 231 9 months ago
4.4.106 241 9 months ago
4.4.105 225 9 months ago
4.4.104 1,149 2/22/2024
4.4.103 324 2/21/2024
4.4.102 399 2/16/2024
4.4.101 330 2/15/2024
4.4.100 370 2/14/2024
4.4.99 310 2/14/2024
4.4.98 612 2/2/2024
4.4.97 324 2/1/2024
4.4.96 2,261 1/28/2024
4.4.95 320 1/27/2024
4.4.94 322 1/26/2024
4.4.93 713 1/18/2024
4.4.92 343 1/16/2024
4.4.91 358 1/14/2024
4.4.90 347 1/13/2024
4.4.89 327 1/12/2024
4.4.88 338 1/11/2024
4.4.87 334 1/10/2024
4.4.86 445 1/7/2024
4.4.85 922 12/21/2023
4.4.84 330 12/19/2023
4.4.83 579 12/8/2023
4.4.82 434 12/3/2023
4.4.81 367 12/1/2023
4.4.80 372 11/30/2023
4.4.79 363 11/29/2023
4.4.78 399 11/26/2023
4.4.77 355 11/25/2023
4.4.76 368 11/24/2023
4.4.75 351 11/23/2023
4.4.74 384 11/21/2023
4.4.73 597 11/4/2023
4.4.72 317 11/3/2023
4.4.71 340 11/2/2023
4.4.70 300 11/1/2023
4.4.69 439 10/29/2023
4.4.68 335 10/28/2023
4.4.67 332 10/27/2023
4.4.66 341 10/26/2023
4.4.65 394 10/25/2023
4.4.64 1,887 10/12/2023
4.4.63 1,875 10/6/2023
4.4.62 1,003 9/24/2023
4.4.61 381 9/21/2023
4.4.60 323 9/21/2023
4.4.59 574 9/17/2023
4.4.58 328 9/16/2023
4.4.57 381 9/15/2023
4.4.56 371 9/14/2023
4.4.55 356 9/13/2023
4.4.54 452 9/11/2023
4.4.53 348 9/10/2023
4.4.52 365 9/9/2023
4.4.51 433 9/6/2023
4.4.50 415 9/3/2023
4.4.49 380 9/1/2023
4.4.48 418 8/31/2023
4.4.47 633 8/18/2023
4.4.46 541 8/11/2023
4.4.45 406 8/10/2023
4.4.44 376 8/8/2023
4.4.43 7,809 7/22/2023
4.4.42 404 7/20/2023
4.4.41 404 7/17/2023
4.4.40 386 7/15/2023
4.4.39 410 7/13/2023
4.4.38 473 7/9/2023
4.4.37 427 7/6/2023
4.4.36 404 7/4/2023
4.4.35 518 6/28/2023
4.4.34 417 6/27/2023
4.4.33 1,252 6/24/2023
4.4.32 925 6/22/2023
4.4.31 1,277 6/21/2023
4.4.30 441 6/20/2023
4.4.29 498 6/15/2023
4.4.28 381 6/14/2023
4.4.27 461 6/12/2023
4.4.26 436 6/10/2023
4.4.25 556 6/8/2023
4.4.24 2,766 6/5/2023
4.4.23 21,209 3/24/2023
4.4.22 1,696 3/20/2023
4.4.21 774 3/15/2023
4.4.20 576 3/10/2023
4.4.19 798 3/6/2023
4.4.17 3,959 2/15/2023
4.4.16 5,665 2/1/2023
4.4.15 932 1/18/2023
4.4.14 1,756 12/8/2022
4.4.13 1,556 12/7/2022
4.4.12 2,222 11/2/2022
4.4.11 1,091 8/30/2022
4.4.10 2,049 8/10/2022
4.4.9 1,195 7/27/2022
4.4.8 233,406 6/29/2022
4.4.7 912 6/22/2022
4.4.6 900 6/15/2022
4.4.5 1,064 5/25/2022
4.4.3 1,195 5/4/2022
4.4.2 861 4/27/2022
4.4.1 923 4/20/2022
4.4.0 1,316 4/7/2022
4.3.17 1,647 3/31/2022 4.3.17 is deprecated because it is no longer maintained.
4.3.16 1,626 3/2/2022 4.3.16 is deprecated because it is no longer maintained.
4.3.15 3,441 2/2/2022 4.3.15 is deprecated because it is no longer maintained.
4.3.14 1,271 1/25/2022 4.3.14 is deprecated because it is no longer maintained.
4.3.13 14,512 12/22/2021 4.3.13 is deprecated because it is no longer maintained.
4.3.12 861 12/15/2021 4.3.12 is deprecated because it is no longer maintained.
4.3.11 834 12/1/2021 4.3.11 is deprecated because it is no longer maintained.
4.3.10 842 11/17/2021 4.3.10 is deprecated because it is no longer maintained.
4.3.9 1,228 11/3/2021 4.3.9 is deprecated because it is no longer maintained.
4.3.8 996 10/6/2021 4.3.8 is deprecated because it is no longer maintained.
4.3.6 923 9/15/2021 4.3.6 is deprecated because it is no longer maintained.
4.3.5 210 9/1/2021 4.3.5 is deprecated because it is no longer maintained.
4.3.4 723 8/17/2021 4.3.4 is deprecated because it is no longer maintained.
4.3.3 249 8/3/2021 4.3.3 is deprecated because it is no longer maintained.
4.3.0 580 6/16/2021 4.3.0 is deprecated because it is no longer maintained.
4.2.4 2,422 5/11/2021 4.2.4 is deprecated because it is no longer maintained.
4.2.1 1,618 2/3/2021 4.2.1 is deprecated because it is no longer maintained.
4.2.0 981 1/6/2021 4.2.0 is deprecated because it is no longer maintained.
4.1.10 1,856 8/10/2020 4.1.10 is deprecated because it is no longer maintained.
4.1.8 355 7/13/2020 4.1.8 is deprecated because it is no longer maintained.
4.1.7 584 6/30/2020 4.1.7 is deprecated because it is no longer maintained.
4.1.6 1,921 5/29/2020 4.1.6 is deprecated because it is no longer maintained.
4.1.0-beta.26 325 2/18/2020 4.1.0-beta.26 is deprecated because it is no longer maintained.
4.1.0-beta.25 266 2/13/2020 4.1.0-beta.25 is deprecated because it is no longer maintained.
4.1.0-beta.19 310 1/7/2020 4.1.0-beta.19 is deprecated because it is no longer maintained.
4.1.0-beta.18 319 1/7/2020 4.1.0-beta.18 is deprecated because it is no longer maintained.