FiftyOne.DeviceDetection.Shared 4.5.0-alpha.12

This is a prerelease version of FiftyOne.DeviceDetection.Shared.
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.5.0-alpha.12                
NuGet\Install-Package FiftyOne.DeviceDetection.Shared -Version 4.5.0-alpha.12                
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.5.0-alpha.12" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FiftyOne.DeviceDetection.Shared --version 4.5.0-alpha.12                
#r "nuget: FiftyOne.DeviceDetection.Shared, 4.5.0-alpha.12"                
#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.Shared as a Cake Addin
#addin nuget:?package=FiftyOne.DeviceDetection.Shared&version=4.5.0-alpha.12&prerelease

// Install FiftyOne.DeviceDetection.Shared as a Cake Tool
#tool nuget:?package=FiftyOne.DeviceDetection.Shared&version=4.5.0-alpha.12&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 (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.57 0 12/18/2024
4.5.0-alpha.53 43 12/16/2024
4.5.0-alpha.51 38 12/16/2024
4.5.0-alpha.50 47 12/16/2024
4.5.0-alpha.43 43 12/2/2024
4.5.0-alpha.32 58 11/14/2024
4.5.0-alpha.30 44 11/13/2024
4.5.0-alpha.28 43 11/12/2024
4.5.0-alpha.26 44 11/9/2024
4.5.0-alpha.24 44 11/7/2024
4.5.0-alpha.22 34 11/6/2024
4.5.0-alpha.18 43 11/5/2024
4.5.0-alpha.14 83 10/15/2024
4.5.0-alpha.12 44 10/14/2024
4.5.0-alpha.11 48 10/13/2024
4.5.0-alpha.9 56 10/10/2024
4.4.203 0 12/18/2024
4.4.202 47 12/17/2024
4.4.201 147 12/16/2024
4.4.200 408 12/11/2024
4.4.199 188 12/10/2024
4.4.198 502 12/3/2024
4.4.197 246 12/2/2024
4.4.196 188 12/1/2024
4.4.195 298 11/27/2024
4.4.194 702 11/14/2024
4.4.193 208 11/13/2024
4.4.192 204 11/12/2024
4.4.191 355 11/9/2024
4.4.190 255 11/6/2024
4.4.189 249 11/5/2024
4.4.188 218 11/3/2024
4.4.187 220 11/2/2024
4.4.186 463 10/23/2024
4.4.185 199 10/22/2024
4.4.184 616 10/18/2024
4.4.183 263 10/17/2024
4.4.182 1,126 10/10/2024
4.4.181 263 10/8/2024
4.4.180 298 10/4/2024
4.4.179 571 10/2/2024
4.4.178 242 10/1/2024
4.4.177 644 9/30/2024
4.4.176 259 9/28/2024
4.4.175 909 9/13/2024
4.4.174 346 9/10/2024
4.4.173 288 9/8/2024
4.4.172 268 9/7/2024
4.4.171 293 9/5/2024
4.4.170 272 9/4/2024
4.4.169 263 9/3/2024
4.4.168 315 8/30/2024
4.4.167 251 8/29/2024
4.4.166 636 8/20/2024
4.4.165 398 8/15/2024
4.4.164 263 8/14/2024
4.4.163 371 8/13/2024
4.4.162 734 8/7/2024
4.4.161 527 8/6/2024
4.4.160 206 8/5/2024
4.4.159 190 8/3/2024
4.4.158 177 7/30/2024
4.4.157 215 7/26/2024
4.4.156 127 7/26/2024
4.4.155 286 7/24/2024
4.4.154 645 7/19/2024
4.4.153 240 7/18/2024
4.4.152 234 7/17/2024
4.4.151 240 7/16/2024
4.4.150 241 7/15/2024
4.4.149 403 7/11/2024
4.4.148 251 7/10/2024
4.4.147 287 7/9/2024
4.4.146 276 7/7/2024
4.4.145 302 7/4/2024
4.4.144 494 6/27/2024
4.4.143 269 6/25/2024
4.4.142 972 6/19/2024
4.4.141 295 6/19/2024
4.4.140 341 6/15/2024
4.4.139 309 6/11/2024
4.4.138 926 6/1/2024
4.4.137 257 5/31/2024
4.4.136 313 5/29/2024
4.4.135 241 5/29/2024
4.4.134 2,688 5/25/2024
4.4.133 385 5/22/2024
4.4.132 376 5/18/2024
4.4.131 369 5/17/2024
4.4.130 251 5/16/2024
4.4.129 189 5/16/2024
4.4.128 201 5/15/2024
4.4.127 187 5/15/2024
4.4.126 263 5/14/2024
4.4.125 568 5/13/2024
4.4.124 268 5/12/2024
4.4.123 194 5/12/2024
4.4.122 441 5/8/2024
4.4.121 465 5/3/2024
4.4.120 201 5/2/2024
4.4.119 298 4/30/2024
4.4.118 419 4/28/2024
4.4.117 491 4/25/2024
4.4.116 422 4/23/2024
4.4.115 348 4/21/2024
4.4.114 309 4/20/2024
4.4.113 5,425 4/10/2024
4.4.112 299 4/4/2024
4.4.111 852 3/27/2024
4.4.110 1,900 3/21/2024
4.4.109 323 3/21/2024
4.4.108 469 3/19/2024
4.4.107 370 3/18/2024
4.4.106 361 3/17/2024
4.4.105 357 3/16/2024
4.4.104 1,302 2/22/2024
4.4.103 495 2/21/2024
4.4.102 597 2/16/2024
4.4.101 575 2/15/2024
4.4.100 562 2/14/2024
4.4.99 523 2/14/2024
4.4.98 859 2/2/2024
4.4.97 811 2/1/2024
4.4.96 2,514 1/28/2024
4.4.95 568 1/27/2024
4.4.94 563 1/26/2024
4.4.93 998 1/18/2024
4.4.92 596 1/16/2024
4.4.91 618 1/14/2024
4.4.90 583 1/13/2024
4.4.89 585 1/12/2024
4.4.88 606 1/11/2024
4.4.87 603 1/10/2024
4.4.86 677 1/7/2024
4.4.85 1,197 12/21/2023
4.4.84 603 12/19/2023
4.4.83 797 12/8/2023
4.4.82 689 12/3/2023
4.4.81 630 12/1/2023
4.4.80 619 11/30/2023
4.4.79 622 11/29/2023
4.4.78 639 11/26/2023
4.4.77 639 11/25/2023
4.4.76 633 11/24/2023
4.4.75 609 11/23/2023
4.4.74 651 11/21/2023
4.4.73 849 11/4/2023
4.4.72 575 11/3/2023
4.4.71 608 11/2/2023
4.4.70 579 11/1/2023
4.4.69 677 10/29/2023
4.4.68 600 10/28/2023
4.4.67 595 10/27/2023
4.4.66 599 10/26/2023
4.4.65 652 10/25/2023
4.4.64 2,173 10/12/2023
4.4.63 2,129 10/6/2023
4.4.62 1,398 9/24/2023
4.4.61 649 9/21/2023
4.4.60 570 9/21/2023
4.4.59 811 9/17/2023
4.4.58 590 9/16/2023
4.4.57 637 9/15/2023
4.4.56 644 9/14/2023
4.4.55 600 9/13/2023
4.4.54 709 9/11/2023
4.4.53 606 9/10/2023
4.4.52 607 9/9/2023
4.4.51 695 9/6/2023
4.4.50 633 9/3/2023
4.4.49 643 9/1/2023
4.4.48 755 8/31/2023
4.4.47 897 8/18/2023
4.4.46 830 8/11/2023
4.4.45 712 8/10/2023
4.4.44 657 8/8/2023
4.4.43 8,178 7/22/2023
4.4.42 664 7/20/2023
4.4.41 682 7/17/2023
4.4.40 661 7/15/2023
4.4.39 707 7/13/2023
4.4.38 756 7/9/2023
4.4.37 705 7/6/2023
4.4.36 683 7/4/2023
4.4.35 1,017 6/28/2023
4.4.34 707 6/27/2023
4.4.33 1,530 6/24/2023
4.4.32 1,173 6/22/2023
4.4.31 1,524 6/21/2023
4.4.30 739 6/20/2023
4.4.29 787 6/15/2023
4.4.28 680 6/14/2023
4.4.27 788 6/12/2023
4.4.26 746 6/10/2023
4.4.25 851 6/8/2023
4.4.24 2,975 6/5/2023
4.4.23 22,374 3/24/2023
4.4.22 1,808 3/20/2023
4.4.21 1,173 3/15/2023
4.4.20 1,004 3/10/2023
4.4.19 1,187 3/6/2023
4.4.17 4,106 2/15/2023
4.4.16 6,142 2/1/2023
4.4.15 1,449 1/18/2023
4.4.14 2,468 12/8/2022
4.4.13 2,109 12/7/2022
4.4.12 3,040 11/2/2022
4.4.11 1,751 8/30/2022
4.4.10 2,731 8/10/2022
4.4.9 1,815 7/27/2022
4.4.8 230,223 6/29/2022
4.4.7 1,604 6/22/2022
4.4.6 1,595 6/15/2022
4.4.5 1,783 5/25/2022
4.4.3 1,972 5/4/2022
4.4.2 1,916 4/27/2022
4.4.1 1,820 4/20/2022
4.4.0 2,056 4/7/2022
4.3.17 3,545 3/31/2022
4.3.16 2,328 3/2/2022
4.3.15 4,107 2/2/2022
4.3.14 1,942 1/25/2022
4.3.13 14,987 12/22/2021
4.3.12 1,331 12/15/2021
4.3.11 1,287 12/1/2021
4.3.10 1,410 11/17/2021
4.3.9 1,736 11/3/2021
4.3.8 1,492 10/6/2021
4.3.6 937 9/15/2021
4.3.5 173 9/1/2021
4.3.4 704 8/17/2021
4.3.3 237 8/3/2021
4.3.0 570 6/16/2021
4.2.4 2,392 5/11/2021
4.2.1 1,583 2/3/2021
4.2.0 1,542 1/6/2021
4.1.10 2,694 8/10/2020
4.1.8 342 7/13/2020
4.1.7 568 6/30/2020
4.1.6 1,923 5/29/2020
4.1.0-beta.26 311 2/18/2020
4.1.0-beta.25 236 2/13/2020
4.1.0-beta.19 277 1/7/2020
4.1.0-beta.18 303 1/7/2020