Check out the latest documentation.

What's Covered

This tutorial illustrates the basic use of the 51Degrees API. It will show you how to create a provider, how to create a dataset and how to obtain a value for the IsMobile property.

Code and Explanation

Getting started example of using 51Degrees device detection. The example shows how to:

  1. Set the various settings for 51Degrees detector

    my $filename = "51Degrees-LiteV3.2.dat";
    my $propertyList = "IsMobile";
    my $cacheSize = 10000;
    my $poolSize = 20;

  • Instantiate the 51Degrees device detection provider with these properties

    my $provider = new FiftyOneDegrees::PatternV3::Provider(
  • Produce a match for a single HTTP User-Agent header

    my $match = $provider->getMatch($userAgent)
  • Extract the value of the IsMobile property

    This example assumes you are running from the original subdirectory i.e. Device-Detection/perl/examples/ and the 51Degrees Perl module is installed.

    Full Source File
    use FiftyOneDegrees::PatternV3;
    use feature qw/say/;
    my $filename = "../../data/51Degrees-LiteV3.2.dat";
    my $propertyList = "IsMobile";
    my $cacheSize = 10000;
    my $poolSize = 20;
    # User-Agent string of an iPhone mobile device.
    my $mobileUserAgent = "Mozilla/5.0 (iPhone; CPU iPhone OS 7_1 like Mac OS X) ".
    "AppleWebKit/537.51.2 (KHTML, like Gecko) 'Version/7.0 ".
    "Mobile/11D167 Safari/9537.53";
    # User-Agent string of Firefox Web browser version 41 on desktop.
    my $desktopUserAgent = "Mozilla/5.0 (Windows NT 6.3; WOW64; rv:41.0) ".
    "Gecko/20100101 Firefox/41.0";
    # User-Agent string of a MediaHub device.
    my $mediaHubUserAgent = "Mozilla/5.0 (Linux; Android 4.4.2; X7 Quad Core ".
    "Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 ".
    "Chrome/ Safari/537.36";
    # Initialises the device detection provider with the settings declared above.
    # This uses Lite data file. For more info
    # see:
    # <a href="">compare data options
    # </a>
    my $provider = new FiftyOneDegrees::PatternV3::Provider(
    say "Starting Getting Started Example.";
    # Carries out a match with a mobile User-Agent.
    say "\nMobile User-Agent: $mobileUserAgent";
    my $match = $provider->getMatch($mobileUserAgent);
    my $isMobile =  $match->getValue("IsMobile");
    say "   IsMobile: $isMobile";
    # Carries out a desktop with a mobile User-Agent.
    say "\nDesktop User-Agent: $desktopUserAgent";
    my $match = $provider->getMatch($desktopUserAgent);
    my $isMobile =  $match->getValue("IsMobile");
    say "   IsMobile: $isMobile";
    # Carries out a MediaHub with a mobile User-Agent.
    say "\nMediaHub User-Agent: $mediaHubUserAgent";
    my $match = $provider->getMatch($mediaHubUserAgent);
    my $isMobile =  $match->getValue("IsMobile");
    say "   IsMobile: $isMobile";
    Full Source File

  • Summary

    In this tutorial you have seen how to use the detector to retrieve the IsMobile property for a pre-defined User-Agent string. The example can easily be modified to retrieve the value of any other property. Premium and Enterprise data files provide considerably more properties such as IsCrawler , PriceBand , HardwareVendor and ScreenInchesWidth . For a full list of properties and the data file versions they exist in please see the Property Dictionary .