Check out the latest documentation.

What's Covered

51Degrees device detector returns all detection results as a string. This tutorial demonstrates how to return results for the IsMobile property value as a boolean.

Code and Explanation

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

  1. Import settings from the 51Degrees settings file

    												
    dataFile = settings.V3_WRAPPER_DATABASE
    properties = settings.PROPERTIES
    cacheSize = settings.CACHE_SIZE
    poolSize = settings.POOL_SIZE
    
    												

  • Instantiate the 51Degrees device detection provider with these properties

    									
    provider = fiftyone_degrees_mobile_detector_v3_wrapper.Provider(dataFile,
    	properties,
    	cacheSize,
    	poolSize)
    
    									
  • Produce a match for a single HTTP User-Agent header

    									
    match = provider.getMatch(userAgent)
    
    									

  • Extract the value of the IsMobile property as boolean

    									
    def isMobile(userAgent):
    	match = provider.getMatch(userAgent)
    	if (match.getValue('IsMobile') == 'True'):
    		return True
    
    
    									
    This example can be run in any directory, but assumes your settings file contains a valid dataFile location and has the IsMobile property selected.

    Full Source File
    												
    from FiftyOneDegrees import fiftyone_degrees_mobile_detector_v3_wrapper
    from fiftyone_degrees.mobile_detector.conf import settings
    import sys
    
    dataFile = settings.V3_WRAPPER_DATABASE
    properties = settings.PROPERTIES
    cacheSize =  settings.CACHE_SIZE
    poolSize = settings.POOL_SIZE
    
    provider = fiftyone_degrees_mobile_detector_v3_wrapper.Provider(dataFile,
        properties,
        cacheSize,
        poolSize)
    
    # User-Agent string of an iPhone mobile device.
    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.
    desktopUserAgent = ("Mozilla/5.0 (Windows NT 6.3; WOW64; rv:41.0) "
    "Gecko/20100101 Firefox/41.0")
    
    # User-Agent string of a MediaHub device.
    mediaHubUserAgent = ("Mozilla/5.0 (Linux; Android 4.4.2; X7 Quad Core "
    "Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 "
    "Chrome/30.0.0.0 Safari/537.36")
    
    '''
    isMobile function. Takes a User-Agent as an argument, carries out a
    match and returns a boolean value for the IsMobile property of the
    matched device.
    '''
    def isMobile(userAgent):
        match = provider.getMatch(userAgent)
        if (match.getValue('IsMobile') == 'True'):
            return True
    
    def main():
        sys.stdout.write('Mobile User-Agent: %s\n' % mobileUserAgent)
    
    # Determines whether the mobile User-Agent is a mobile device.
        if isMobile(mobileUserAgent):
            sys.stdout.write('   Mobile\n')
        else:
            sys.stdout.write('   Non-Mobile\n')
    
    # Determines whether the desktop User-Agent is a mobile device.
        sys.stdout.write('Desktop User-Agent: %s\n' % desktopUserAgent)
        if isMobile(desktopUserAgent):
            sys.stdout.write('   Mobile\n')
        else:
            sys.stdout.write('   Non-Mobile\n')
    
    # Determines whether the MediaHub User-Agent is a mobile device.
        sys.stdout.write('Media Hub User-Agent: %s\n' % mediaHubUserAgent)
        if isMobile(mediaHubUserAgent):
            sys.stdout.write('   Mobile\n')
        else:
            sys.stdout.write('   Non-Mobile\n')
    
    if __name__ == '__main__':
        main()
    
    
    												
    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. It sets a boolean value to true or false from the original string value of "True" or "False", making if statements simpler to test.