FiftyOne.DeviceDetection.Cloud 4.5.0-alpha.96

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

// Install FiftyOne.DeviceDetection.Cloud as a Cake Tool
#tool nuget:?package=FiftyOne.DeviceDetection.Cloud&version=4.5.0-alpha.96&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.  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.Cloud:

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 53 3 days ago
4.5.0-alpha.110 55 6 days ago
4.5.0-alpha.109 40 10 days ago
4.5.0-alpha.108 42 12 days ago
4.5.0-alpha.107 37 13 days ago
4.5.0-alpha.106 38 15 days ago
4.5.0-alpha.105 37 16 days ago
4.5.0-alpha.104 17 17 days ago
4.5.0-alpha.103 14 17 days ago
4.5.0-alpha.102 34 18 days ago
4.5.0-alpha.101 38 20 days ago
4.5.0-alpha.99 346 25 days ago
4.5.0-alpha.98 55 a month ago
4.5.0-alpha.97 90 a month ago
4.5.0-alpha.96 57 a month ago
4.5.0-alpha.94 28 a month ago
4.5.0-alpha.92 42 a month ago
4.5.0-alpha.91 37 a month ago
4.5.0-alpha.84 115 a month ago
4.5.0-alpha.83 30 a month ago
4.5.0-alpha.81 638 a month ago
4.5.0-alpha.79 52 a month ago
4.5.0-alpha.77 16 a month ago
4.5.0-alpha.75 29 2 months ago
4.5.0-alpha.73 214 2 months ago
4.5.0-alpha.71 54 2 months ago
4.5.0-alpha.67 154 2 months ago
4.5.0-alpha.65 51 2 months ago
4.5.0-alpha.61 66 2 months ago
4.5.0-alpha.59 61 2 months ago
4.5.0-alpha.57 91 2 months ago
4.5.0-alpha.53 58 2 months ago
4.5.0-alpha.51 47 2 months ago
4.5.0-alpha.50 53 2 months ago
4.5.0-alpha.43 57 3 months ago
4.5.0-alpha.32 75 3 months ago
4.5.0-alpha.30 60 3 months ago
4.5.0-alpha.28 54 3 months ago
4.5.0-alpha.26 57 3 months ago
4.5.0-alpha.24 56 4 months ago
4.5.0-alpha.22 51 4 months ago
4.5.0-alpha.18 54 4 months ago
4.5.0-alpha.14 95 4 months ago
4.5.0-alpha.12 50 4 months ago
4.5.0-alpha.11 52 4 months ago
4.5.0-alpha.9 61 4 months ago
4.4.230 313 6 days ago
4.4.229 343 12 days ago
4.4.228 269 16 days ago
4.4.227 131 17 days ago
4.4.226 92 18 days ago
4.4.225 109 18 days ago
4.4.224 115 19 days ago
4.4.223 91 19 days ago
4.4.222 93 19 days ago
4.4.221 193 20 days ago
4.4.220 204 22 days ago
4.4.219 214 a month ago
4.4.218 281 a month ago
4.4.217 240 a month ago
4.4.216 197 a month ago
4.4.215 166 a month ago
4.4.214 194 a month ago
4.4.213 225 a month ago
4.4.212 427 a month ago
4.4.211 96 2 months ago
4.4.210 303 2 months ago
4.4.209 200 2 months ago
4.4.208 177 2 months ago
4.4.207 415 2 months ago
4.4.206 223 2 months ago
4.4.205 231 2 months ago
4.4.204 185 2 months ago
4.4.203 195 2 months ago
4.4.202 197 2 months ago
4.4.201 181 2 months ago
4.4.200 412 2 months ago
4.4.199 158 2 months ago
4.4.198 511 3 months ago
4.4.197 225 3 months ago
4.4.196 168 3 months ago
4.4.195 263 3 months ago
4.4.194 674 3 months ago
4.4.193 169 3 months ago
4.4.192 165 3 months ago
4.4.191 438 3 months ago
4.4.190 218 4 months ago
4.4.189 254 4 months ago
4.4.188 186 4 months ago
4.4.187 184 4 months ago
4.4.186 396 4 months ago
4.4.185 161 4 months ago
4.4.184 1,056 4 months ago
4.4.183 221 4 months ago
4.4.182 1,355 4 months ago
4.4.181 210 5 months ago
4.4.180 258 5 months ago
4.4.179 741 5 months ago
4.4.178 225 5 months ago
4.4.177 745 5 months ago
4.4.176 213 5 months ago
4.4.175 956 5 months ago
4.4.174 284 5 months ago
4.4.173 215 6 months ago
4.4.172 186 6 months ago
4.4.171 222 6 months ago
4.4.170 199 6 months ago
4.4.169 201 6 months ago
4.4.168 262 6 months ago
4.4.167 177 6 months ago
4.4.166 535 6 months ago
4.4.165 322 6 months ago
4.4.164 184 6 months ago
4.4.163 287 6 months ago
4.4.162 671 7 months ago
4.4.161 541 7 months ago
4.4.160 146 7 months ago
4.4.159 142 7 months ago
4.4.158 149 7 months ago
4.4.157 193 7 months ago
4.4.156 107 7 months ago
4.4.155 236 7 months ago
4.4.154 911 7 months ago
4.4.153 201 7 months ago
4.4.152 179 7 months ago
4.4.151 182 7 months ago
4.4.150 172 7 months ago
4.4.149 292 7 months ago
4.4.148 202 7 months ago
4.4.147 203 7 months ago
4.4.146 218 8 months ago
4.4.145 264 8 months ago
4.4.144 427 8 months ago
4.4.143 211 8 months ago
4.4.142 766 8 months ago
4.4.141 225 8 months ago
4.4.140 276 8 months ago
4.4.139 246 8 months ago
4.4.138 999 9 months ago
4.4.137 212 9 months ago
4.4.136 252 9 months ago
4.4.135 168 9 months ago
4.4.134 1,294 9 months ago
4.4.133 259 9 months ago
4.4.132 279 9 months ago
4.4.131 315 9 months ago
4.4.130 178 9 months ago
4.4.129 117 9 months ago
4.4.128 158 9 months ago
4.4.127 140 9 months ago
4.4.126 215 9 months ago
4.4.125 699 9 months ago
4.4.124 226 9 months ago
4.4.123 164 9 months ago
4.4.122 318 10 months ago
4.4.121 353 10 months ago
4.4.120 111 10 months ago
4.4.119 199 10 months ago
4.4.118 325 10 months ago
4.4.117 293 4/25/2024
4.4.116 302 4/23/2024
4.4.115 255 4/21/2024
4.4.114 236 4/20/2024
4.4.113 5,463 4/10/2024
4.4.112 204 4/4/2024
4.4.111 588 3/27/2024
4.4.110 1,462 3/21/2024
4.4.109 231 3/21/2024
4.4.108 325 3/19/2024
4.4.107 220 3/18/2024
4.4.106 231 3/17/2024
4.4.105 227 3/16/2024
4.4.104 1,115 2/22/2024
4.4.103 300 2/21/2024
4.4.102 385 2/16/2024
4.4.101 356 2/15/2024
4.4.100 352 2/14/2024
4.4.99 288 2/14/2024
4.4.98 593 2/2/2024
4.4.97 332 2/1/2024
4.4.96 2,262 1/28/2024
4.4.95 303 1/27/2024
4.4.94 310 1/26/2024
4.4.93 719 1/18/2024
4.4.92 329 1/16/2024
4.4.91 341 1/14/2024
4.4.90 325 1/13/2024
4.4.89 318 1/12/2024
4.4.88 311 1/11/2024
4.4.87 330 1/10/2024
4.4.86 427 1/7/2024
4.4.85 911 12/21/2023
4.4.84 311 12/19/2023
4.4.83 550 12/8/2023
4.4.82 405 12/3/2023
4.4.81 340 12/1/2023
4.4.80 338 11/30/2023
4.4.79 355 11/29/2023
4.4.78 350 11/26/2023
4.4.77 325 11/25/2023
4.4.76 348 11/24/2023
4.4.75 329 11/23/2023
4.4.74 363 11/21/2023
4.4.73 590 11/4/2023
4.4.72 316 11/3/2023
4.4.71 331 11/2/2023
4.4.70 301 11/1/2023
4.4.69 415 10/29/2023
4.4.68 333 10/28/2023
4.4.67 316 10/27/2023
4.4.66 333 10/26/2023
4.4.65 372 10/25/2023
4.4.64 1,908 10/12/2023
4.4.63 467 10/6/2023
4.4.62 874 9/24/2023
4.4.61 379 9/21/2023
4.4.60 295 9/21/2023
4.4.59 535 9/17/2023
4.4.58 333 9/16/2023
4.4.57 343 9/15/2023
4.4.56 367 9/14/2023
4.4.55 365 9/13/2023
4.4.54 460 9/11/2023
4.4.53 335 9/10/2023
4.4.52 327 9/9/2023
4.4.51 403 9/6/2023
4.4.50 394 9/3/2023
4.4.49 374 9/1/2023
4.4.48 385 8/31/2023
4.4.47 734 8/18/2023
4.4.46 513 8/11/2023
4.4.45 394 8/10/2023
4.4.44 360 8/8/2023
4.4.43 7,806 7/22/2023
4.4.42 382 7/20/2023
4.4.41 399 7/17/2023
4.4.40 345 7/15/2023
4.4.39 406 7/13/2023
4.4.38 451 7/9/2023
4.4.37 431 7/6/2023
4.4.36 386 7/4/2023
4.4.35 693 6/28/2023
4.4.34 380 6/27/2023
4.4.33 1,340 6/24/2023
4.4.32 920 6/22/2023
4.4.31 1,262 6/21/2023
4.4.30 430 6/20/2023
4.4.29 467 6/15/2023
4.4.28 403 6/14/2023
4.4.27 456 6/12/2023
4.4.26 417 6/10/2023
4.4.25 513 6/8/2023
4.4.24 3,240 6/5/2023
4.4.23 21,623 3/24/2023
4.4.22 1,859 3/20/2023
4.4.21 755 3/15/2023
4.4.20 576 3/10/2023
4.4.19 790 3/6/2023
4.4.17 3,704 2/15/2023
4.4.16 5,730 2/1/2023
4.4.15 944 1/18/2023
4.4.14 1,892 12/8/2022
4.4.13 1,514 12/7/2022
4.4.12 2,497 11/2/2022
4.4.11 1,063 8/30/2022
4.4.10 2,100 8/10/2022
4.4.9 1,138 7/27/2022
4.4.8 246,339 6/29/2022
4.4.7 888 6/22/2022
4.4.6 869 6/15/2022
4.4.5 845 5/25/2022
4.4.3 1,141 5/4/2022
4.4.2 841 4/27/2022
4.4.1 1,087 4/20/2022
4.4.0 874 4/7/2022
4.3.17 1,611 3/31/2022 4.3.17 is deprecated because it is no longer maintained.
4.3.16 1,621 3/2/2022 4.3.16 is deprecated because it is no longer maintained.
4.3.15 3,458 2/2/2022 4.3.15 is deprecated because it is no longer maintained.
4.3.14 1,215 1/25/2022 4.3.14 is deprecated because it is no longer maintained.
4.3.13 14,569 12/22/2021 4.3.13 is deprecated because it is no longer maintained.
4.3.12 833 12/15/2021 4.3.12 is deprecated because it is no longer maintained.
4.3.11 784 12/1/2021 4.3.11 is deprecated because it is no longer maintained.
4.3.10 914 11/17/2021 4.3.10 is deprecated because it is no longer maintained.
4.3.9 1,207 11/3/2021 4.3.9 is deprecated because it is no longer maintained.
4.3.8 945 10/6/2021 4.3.8 is deprecated because it is no longer maintained.
4.3.6 948 9/15/2021 4.3.6 is deprecated because it is no longer maintained.
4.3.5 199 9/1/2021 4.3.5 is deprecated because it is no longer maintained.
4.3.4 720 8/17/2021 4.3.4 is deprecated because it is no longer maintained.
4.3.3 269 8/3/2021 4.3.3 is deprecated because it is no longer maintained.
4.3.0 601 6/16/2021 4.3.0 is deprecated because it is no longer maintained.
4.2.4 2,454 5/11/2021 4.2.4 is deprecated because it is no longer maintained.
4.2.1 1,678 2/3/2021 4.2.1 is deprecated because it is no longer maintained.
4.2.0 962 1/6/2021 4.2.0 is deprecated because it is no longer maintained.
4.1.10 3,155 8/10/2020 4.1.10 is deprecated because it is no longer maintained.
4.1.8 373 7/13/2020 4.1.8 is deprecated because it is no longer maintained.
4.1.7 593 6/30/2020 4.1.7 is deprecated because it is no longer maintained.
4.1.6 1,996 5/29/2020 4.1.6 is deprecated because it is no longer maintained.
4.1.0-beta.26 332 2/18/2020 4.1.0-beta.26 is deprecated because it is no longer maintained.
4.1.0-beta.25 256 2/13/2020 4.1.0-beta.25 is deprecated because it is no longer maintained.
4.1.0-beta.19 307 1/7/2020 4.1.0-beta.19 is deprecated because it is no longer maintained.
4.1.0-beta.18 322 1/7/2020 4.1.0-beta.18 is deprecated because it is no longer maintained.