Previous topic

UDS Modules Samples

Next topic

Sample Service Provider

This Page

Needs for a service packageΒΆ

For a new package of services, you will need:

  • One package (python package), of course :-).

  • One icon for the provider, in png format an 16x16 size. Colours is left to your election. This icon will be informed at Provider class.

  • One icon for every service that the provider will expose. Same as provider icons. These icons will be informed at Service class. Every single class must provide its own icon.

  • Registering the provider. For the samples show here, this will be at __init__ of the package.

    The contents of the sample package __init__ file is:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    # -*- coding: utf-8 -*-
    
    #
    # Copyright (c) 2012 Virtual Cable S.L.
    # All rights reserved.
    #
    # Redistribution and use in source and binary forms, with or without modification, 
    # are permitted provided that the following conditions are met:
    #
    #    * Redistributions of source code must retain the above copyright notice, 
    #      this list of conditions and the following disclaimer.
    #    * Redistributions in binary form must reproduce the above copyright notice, 
    #      this list of conditions and the following disclaimer in the documentation 
    #      and/or other materials provided with the distribution.
    #    * Neither the name of Virtual Cable S.L. nor the names of its contributors 
    #      may be used to endorse or promote products derived from this software 
    #      without specific prior written permission.
    #
    # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
    # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
    # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
    # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
    # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
    # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
    # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
    # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
    # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    
    '''
    Sample Service module.
    
    This package simply shows how a new service can be implemented. 
    
    
    The first thing to do in every package that is a module is register the 
    class that is responsible of providing the module with the system.
    
    For this, we must simply import the class at __init__, UDS will take care
    of the rest
    '''
    
    from SampleProvider import Provider 
    

    Download sample

  • Put the package under the apropiate uds package. In the case of services, this is under “uds.core”.

    Core will look for all packages under “uds.services” and import them at initialization of the server, so every package under this will get their __init__ called, where we register the provider.

  • Follow the samples provided here as base