device-detection-go

README

51Degrees Device Detection Engines

Go Device Detection

Introduction

This repository contains Go Lite implementation of device detection engine. This provides a light set of device detection features that allow Go users to try and evaluate the capability of 51Degrees device detection solution in Go.

Supported platforms and architectures

Go Lite implementation is currently supporting the following platforms and architectures:

• Linux 32/64 bit, Intel and ARM processor
• MacOS 64 bit, Intel and ARM processor
• Windows 64bit, Intel

Go version:

• 1.19

Compiles with go 1.19 and higher. The minimum version of 1.19 is dictated by the fact that this library is used by the prebid-server module and it has a minimum version requirement of go 1.19.

Pre-requisites

Data File

In order to perform device detection, you will need to use a 51Degrees data file. A 'lite' file can be found at device-detection-data. You can run:

pwsh ci/fetch-assets.ps1 .

Or download 51Degrees-LiteV4.1.hash directly.

This 'lite' file has a significantly reduced set of properties. To obtain a file with a more complete set of device properties see the 51Degrees website.

Software

In order to build use device-detection-go the following are required:

• Powershell Core (7 or above)
• A C compiler that support C11 or above (Gcc on Linux, Clang on MacOS and MinGW-x64 on Windows)
• libatomic - which usually come with default Gcc, Clang installation

Windows

If you are on Windows, make sure that:

• The path to the MinGW-x64 bin folder is included in the PATH. By default, the path should be C:\msys64\ucrt64\bin
• Go environment variable CGO_ENABLED is set to 1

go env -w CGO_ENABLED=1

Module and Packages

This module name device-detection-go at path github.com/51Degrees/device-detection-go/v4

This Go Lite version contains the following packages:

• dd - a lower level API wrapping the C device detection library
• onpremise - a higher level Engine API providing device detection and automatic data file updates

Build and Usage

Build steps for all platforms

Import the package as usual and it will get build automatically:

import "github.com/51Degrees/device-detection-go/v4/dd"

Vendored C Library

An amalgamation is an alternative way to distribute a library's source code using only a few files (as low as one or two). This go module depends on and ships an amalgamation of the device-detection C-library device-detection-cxx repository, which is then built automatically by CGo during go build.

The amalgamation is produced automatically and regularly by the Nightly Package Update CI workflow from the device-detection C-library source code.

Test

Unit tests can be run with go test ./... from the root dir.

APIs

To view APIs and their descriptions, users can use go doc in the package directory.

• First navigate to dd or onpremise dir.
• Then run the below to display all APIs, structures and their descriptions.

go doc -all

NOTE: Not all APIs are available. Ones that are not available include string TODO: To be implemented in their descriptions.

Examples

Examples are included in a separate repository at device-detection-examples-go. Users can follow its README.md for details and comments in each examples for how to run them.