FiftyOne.DeviceDetection 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 --version 4.4.248
                    
NuGet\Install-Package FiftyOne.DeviceDetection -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" 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" Version="4.4.248" />
                    
Directory.Packages.props
<PackageReference Include="FiftyOne.DeviceDetection" />
                    
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 --version 4.4.248
                    
#r "nuget: FiftyOne.DeviceDetection, 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&version=4.4.248
                    
Install FiftyOne.DeviceDetection as a Cake Addin
#tool nuget:?package=FiftyOne.DeviceDetection&version=4.4.248
                    
Install FiftyOne.DeviceDetection 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 (1)

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

Package Downloads
Foundation.SitecoreExtensions

Foundation.SitecoreExtensions

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.5.0-alpha.151 0 4 hours ago
4.5.0-alpha.150 29 2 days ago
4.5.0-alpha.149 198 9 days ago
4.5.0-alpha.148 32 12 days ago
4.5.0-alpha.147 92 13 days ago
4.5.0-alpha.146 108 14 days ago
4.5.0-alpha.144 108 15 days ago
4.5.0-alpha.142 110 17 days ago
4.5.0-alpha.131 161 a month ago
4.5.0-alpha.128 135 2 months ago
4.5.0-alpha.127 120 2 months ago
4.5.0-alpha.126 111 2 months ago
4.5.0-alpha.125 1,860 2 months ago
4.5.0-alpha.124 97 2 months ago
4.5.0-alpha.123 99 2 months ago
4.5.0-alpha.122 433 2 months ago
4.5.0-alpha.121 106 2 months ago
4.5.0-alpha.120 114 2 months ago
4.5.0-alpha.119 125 2 months ago
4.5.0-alpha.118 167 2 months ago
4.5.0-alpha.117 182 3 months ago
4.5.0-alpha.116 160 3 months ago
4.5.0-alpha.115 56 3 months ago
4.5.0-alpha.114 54 3 months ago
4.5.0-alpha.112 57 3 months ago
4.5.0-alpha.111 69 3 months ago
4.5.0-alpha.110 76 3 months ago
4.5.0-alpha.109 60 3 months ago
4.5.0-alpha.108 67 3 months ago
4.5.0-alpha.107 65 3 months ago
4.5.0-alpha.106 70 3 months ago
4.5.0-alpha.105 65 3 months ago
4.5.0-alpha.104 62 3 months ago
4.5.0-alpha.103 54 4 months ago
4.5.0-alpha.102 59 4 months ago
4.5.0-alpha.101 66 4 months ago
4.5.0-alpha.99 1,958 4 months ago
4.5.0-alpha.98 85 4 months ago
4.5.0-alpha.97 111 4 months ago
4.5.0-alpha.96 76 4 months ago
4.5.0-alpha.94 52 4 months ago
4.5.0-alpha.92 52 4 months ago
4.5.0-alpha.91 56 4 months ago
4.5.0-alpha.84 132 4 months ago
4.5.0-alpha.83 41 4 months ago
4.5.0-alpha.81 1,698 4 months ago
4.5.0-alpha.79 58 4 months ago
4.5.0-alpha.77 38 4 months ago
4.5.0-alpha.75 46 4 months ago
4.5.0-alpha.73 224 5 months ago
4.5.0-alpha.71 58 5 months ago
4.5.0-alpha.67 389 5 months ago
4.5.0-alpha.65 56 5 months ago
4.5.0-alpha.61 71 5 months ago
4.5.0-alpha.59 65 5 months ago
4.5.0-alpha.57 93 5 months ago
4.5.0-alpha.53 62 5 months ago
4.5.0-alpha.51 54 5 months ago
4.5.0-alpha.50 58 5 months ago
4.5.0-alpha.43 59 6 months ago
4.5.0-alpha.32 70 6 months ago
4.5.0-alpha.30 63 6 months ago
4.5.0-alpha.28 57 6 months ago
4.5.0-alpha.26 59 6 months ago
4.5.0-alpha.24 53 6 months ago
4.5.0-alpha.22 51 7 months ago
4.5.0-alpha.18 56 7 months ago
4.5.0-alpha.14 88 7 months ago
4.5.0-alpha.12 51 7 months ago
4.5.0-alpha.11 51 7 months ago
4.5.0-alpha.9 60 7 months ago
4.4.248 1,399 a month ago
4.4.247 741 2 months ago
4.4.246 200 2 months ago
4.4.245 203 2 months ago
4.4.244 203 2 months ago
4.4.243 750 2 months ago
4.4.242 176 2 months ago
4.4.241 283 2 months ago
4.4.240 209 2 months ago
4.4.239 350 2 months ago
4.4.238 278 2 months ago
4.4.237 462 3 months ago
4.4.236 194 3 months ago
4.4.235 150 3 months ago
4.4.234 195 3 months ago
4.4.233 106 3 months ago
4.4.232 193 3 months ago
4.4.231 88 3 months ago
4.4.230 455 3 months ago
4.4.229 367 3 months ago
4.4.228 295 3 months ago
4.4.227 154 3 months ago
4.4.226 159 4 months ago
4.4.225 113 4 months ago
4.4.224 111 4 months ago
4.4.223 107 4 months ago
4.4.222 106 4 months ago
4.4.221 216 4 months ago
4.4.220 207 4 months ago
4.4.219 264 4 months ago
4.4.218 321 4 months ago
4.4.217 264 4 months ago
4.4.216 212 4 months ago
4.4.215 171 4 months ago
4.4.214 191 4 months ago
4.4.213 230 4 months ago
4.4.212 573 4 months ago
4.4.211 169 4 months ago
4.4.210 312 5 months ago
4.4.209 210 5 months ago
4.4.208 159 5 months ago
4.4.207 410 5 months ago
4.4.206 204 5 months ago
4.4.205 205 5 months ago
4.4.204 174 5 months ago
4.4.203 184 5 months ago
4.4.202 177 5 months ago
4.4.201 166 5 months ago
4.4.200 409 5 months ago
4.4.199 152 5 months ago
4.4.198 440 6 months ago
4.4.197 205 6 months ago
4.4.196 154 6 months ago
4.4.195 249 6 months ago
4.4.194 630 6 months ago
4.4.193 141 6 months ago
4.4.192 152 6 months ago
4.4.191 542 6 months ago
4.4.190 201 7 months ago
4.4.189 250 7 months ago
4.4.188 160 7 months ago
4.4.187 163 7 months ago
4.4.186 388 7 months ago
4.4.185 143 7 months ago
4.4.184 1,973 7 months ago
4.4.183 198 7 months ago
4.4.182 1,859 7 months ago
4.4.181 197 7 months ago
4.4.180 246 8 months ago
4.4.179 945 8 months ago
4.4.178 238 8 months ago
4.4.177 950 8 months ago
4.4.176 189 8 months ago
4.4.175 1,059 8 months ago
4.4.174 224 8 months ago
4.4.173 175 8 months ago
4.4.172 157 8 months ago
4.4.171 184 9 months ago
4.4.170 163 9 months ago
4.4.169 168 9 months ago
4.4.168 236 9 months ago
4.4.167 153 9 months ago
4.4.166 512 9 months ago
4.4.165 299 9 months ago
4.4.164 171 9 months ago
4.4.163 264 9 months ago
4.4.162 1,276 9 months ago
4.4.161 677 10 months ago
4.4.160 134 10 months ago
4.4.159 114 10 months ago
4.4.158 142 10 months ago
4.4.157 188 10 months ago
4.4.156 89 10 months ago
4.4.155 214 10 months ago
4.4.154 1,151 7/19/2024
4.4.153 173 7/18/2024
4.4.152 156 7/17/2024
4.4.151 158 7/16/2024
4.4.150 145 7/15/2024
4.4.149 252 7/11/2024
4.4.148 189 7/10/2024
4.4.147 169 7/9/2024
4.4.146 195 7/7/2024
4.4.145 235 7/4/2024
4.4.144 400 6/27/2024
4.4.143 183 6/25/2024
4.4.142 751 6/19/2024
4.4.141 188 6/19/2024
4.4.140 238 6/15/2024
4.4.139 223 6/11/2024
4.4.138 1,277 6/1/2024
4.4.137 175 5/31/2024
4.4.136 223 5/29/2024
4.4.135 137 5/29/2024
4.4.134 1,857 5/25/2024
4.4.133 247 5/22/2024
4.4.132 252 5/18/2024
4.4.131 144 5/17/2024
4.4.130 150 5/16/2024
4.4.129 111 5/16/2024
4.4.128 139 5/15/2024
4.4.127 129 5/15/2024
4.4.126 196 5/14/2024
4.4.125 834 5/13/2024
4.4.124 381 5/12/2024
4.4.123 129 5/12/2024
4.4.122 303 5/8/2024
4.4.121 302 5/3/2024
4.4.120 96 5/2/2024
4.4.119 178 4/30/2024
4.4.118 330 4/28/2024
4.4.117 222 4/25/2024
4.4.116 269 4/23/2024
4.4.115 225 4/21/2024
4.4.114 218 4/20/2024
4.4.113 5,948 4/10/2024
4.4.112 174 4/4/2024
4.4.111 565 3/27/2024
4.4.110 1,586 3/21/2024
4.4.109 195 3/21/2024
4.4.108 259 3/19/2024
4.4.107 201 3/18/2024
4.4.106 197 3/17/2024
4.4.105 187 3/16/2024
4.4.104 1,083 2/22/2024
4.4.103 282 2/21/2024
4.4.102 347 2/16/2024
4.4.101 278 2/15/2024
4.4.100 303 2/14/2024
4.4.99 260 2/14/2024
4.4.98 566 2/2/2024
4.4.97 344 2/1/2024
4.4.96 2,233 1/28/2024
4.4.95 269 1/27/2024
4.4.94 293 1/26/2024
4.4.93 716 1/18/2024
4.4.92 311 1/16/2024
4.4.91 322 1/14/2024
4.4.90 303 1/13/2024
4.4.89 281 1/12/2024
4.4.88 298 1/11/2024
4.4.87 284 1/10/2024
4.4.86 401 1/7/2024
4.4.85 1,172 12/21/2023
4.4.84 295 12/19/2023
4.4.83 531 12/8/2023
4.4.82 366 12/3/2023
4.4.81 309 12/1/2023
4.4.80 301 11/30/2023
4.4.79 318 11/29/2023
4.4.78 324 11/26/2023
4.4.77 284 11/25/2023
4.4.76 317 11/24/2023
4.4.75 306 11/23/2023
4.4.74 324 11/21/2023
4.4.73 549 11/4/2023
4.4.72 273 11/3/2023
4.4.71 292 11/2/2023
4.4.70 262 11/1/2023
4.4.69 385 10/29/2023
4.4.68 303 10/28/2023
4.4.67 284 10/27/2023
4.4.66 304 10/26/2023
4.4.65 333 10/25/2023
4.4.64 1,860 10/12/2023
4.4.63 435 10/6/2023
4.4.62 837 9/24/2023
4.4.61 355 9/21/2023
4.4.60 274 9/21/2023
4.4.59 513 9/17/2023
4.4.58 290 9/16/2023
4.4.57 314 9/15/2023
4.4.56 332 9/14/2023
4.4.55 318 9/13/2023
4.4.54 426 9/11/2023
4.4.53 320 9/10/2023
4.4.52 300 9/9/2023
4.4.51 384 9/6/2023
4.4.50 359 9/3/2023
4.4.49 341 9/1/2023
4.4.48 379 8/31/2023
4.4.47 853 8/18/2023
4.4.46 474 8/11/2023
4.4.45 371 8/10/2023
4.4.44 336 8/8/2023
4.4.43 7,162 7/22/2023
4.4.42 368 7/20/2023
4.4.41 362 7/17/2023
4.4.40 314 7/15/2023
4.4.39 372 7/13/2023
4.4.38 422 7/9/2023
4.4.37 377 7/6/2023
4.4.36 359 7/4/2023
4.4.35 421 6/28/2023
4.4.34 342 6/27/2023
4.4.33 1,312 6/24/2023
4.4.32 880 6/22/2023
4.4.31 1,235 6/21/2023
4.4.30 371 6/20/2023
4.4.29 430 6/15/2023
4.4.28 368 6/14/2023
4.4.27 386 6/12/2023
4.4.26 370 6/10/2023
4.4.25 461 6/8/2023
4.4.24 4,496 6/5/2023
4.4.23 20,629 3/24/2023
4.4.22 1,916 3/20/2023
4.4.21 631 3/15/2023
4.4.20 475 3/10/2023
4.4.19 670 3/6/2023
4.4.17 3,841 2/15/2023
4.4.16 5,342 2/1/2023
4.4.15 779 1/18/2023
4.4.14 1,572 12/8/2022
4.4.13 1,352 12/7/2022
4.4.12 2,255 11/2/2022
4.4.11 814 8/30/2022
4.4.10 1,981 8/10/2022
4.4.9 977 7/27/2022
4.4.8 275,839 6/29/2022
4.4.7 665 6/22/2022
4.4.6 624 6/15/2022
4.4.5 620 5/25/2022
4.4.3 876 5/4/2022
4.4.2 622 4/27/2022
4.4.1 635 4/20/2022
4.4.0 670 4/7/2022
4.3.17 1,383 3/31/2022 4.3.17 is deprecated because it is no longer maintained.
4.3.16 1,366 3/2/2022 4.3.16 is deprecated because it is no longer maintained.
4.3.15 3,158 2/2/2022 4.3.15 is deprecated because it is no longer maintained.
4.3.14 971 1/25/2022 4.3.14 is deprecated because it is no longer maintained.
4.3.13 14,785 12/22/2021 4.3.13 is deprecated because it is no longer maintained.
4.3.12 672 12/15/2021 4.3.12 is deprecated because it is no longer maintained.
4.3.11 636 12/1/2021 4.3.11 is deprecated because it is no longer maintained.
4.3.10 644 11/17/2021 4.3.10 is deprecated because it is no longer maintained.
4.3.9 1,032 11/3/2021 4.3.9 is deprecated because it is no longer maintained.
4.3.8 773 10/6/2021 4.3.8 is deprecated because it is no longer maintained.
4.3.6 895 9/15/2021 4.3.6 is deprecated because it is no longer maintained.
4.3.5 201 9/1/2021 4.3.5 is deprecated because it is no longer maintained.
4.3.4 705 8/17/2021 4.3.4 is deprecated because it is no longer maintained.
4.3.3 238 8/3/2021 4.3.3 is deprecated because it is no longer maintained.
4.3.0 552 6/16/2021 4.3.0 is deprecated because it is no longer maintained.
4.2.4 2,538 5/11/2021 4.2.4 is deprecated because it is no longer maintained.
4.2.1 1,754 2/3/2021 4.2.1 is deprecated because it is no longer maintained.
4.2.0 787 1/6/2021 4.2.0 is deprecated because it is no longer maintained.
4.1.10 1,784 8/10/2020 4.1.10 is deprecated because it is no longer maintained.
4.1.8 342 7/13/2020 4.1.8 is deprecated because it is no longer maintained.
4.1.7 575 6/30/2020 4.1.7 is deprecated because it is no longer maintained.
4.1.6 2,001 5/29/2020 4.1.6 is deprecated because it is no longer maintained.
4.1.0-beta.26 319 2/18/2020 4.1.0-beta.26 is deprecated because it is no longer maintained.
4.1.0-beta.25 245 2/13/2020 4.1.0-beta.25 is deprecated because it is no longer maintained.
4.1.0-beta.22 304 1/17/2020 4.1.0-beta.22 is deprecated because it is no longer maintained.
4.1.0-beta.19 289 1/7/2020 4.1.0-beta.19 is deprecated because it is no longer maintained.
4.1.0-beta.18 304 1/7/2020 4.1.0-beta.18 is deprecated because it is no longer maintained.