tools/AmbSignalMapper/README

   1 AmbSignalMapper
   2
   3 ABSTRACT:
   4
   5 The AmbSignalMapper tool serves basic utilities for AMB signal mapping process.
   6 It should take place in three steps:
   7
   8 1. Vector CANdb++ conversion into intermediate file (First phase)
   9 2. Manual annotation of intermediate file (Second phase)
  10 3. Processing of intermediate file and AMB plugin and WebIDL creation (Third phase)
  11
  12 The First phase is achieved by software utolity called dbc2json.
  13 The second phase needs to be done by humans manually.
  14 The third phase is again covered by software utolity called json2amb.
  15
  16 PREREQUISITES:
  17
  18 Perl version 5.006 or higher.
  19
  20 The following modules are needed to succesfuly build and run the AmbSignalMapper tool:
  21     'ExtUtils::MakeMaker'
  22     'Test::More',
  23     'Parse::RecDescent',
  24     'Exporter',
  25     'JSON',
  26     'Data::UUID',
  27     'File::Basename',
  28     'File::Spec',
  29     'Cwd',
  30     'Digest::SHA1'.
  31
  32 These modules are optional for executing moodule tests:
  33     'Test::Pod',
  34     'Test::Pod::Coverage',
  35
  36 The following command is an example of Data::UUID module instalation.
  37 Note that sudo credentials might be needed on users linux box.
  38
  39     cpan install Data::UUID
  40
  41 INSTALLATION
  42
  43 To install this module, run the following commands:
  44
  45     perl Makefile.PL
  46     make
  47     make test
  48     make install
  49
  50 SUPPORT AND DOCUMENTATION
  51
  52 After installing, you can find documentation for this module with the
  53 perldoc command.
  54
  55     perldoc dbc2json
  56
  57     perldoc json2amb
  58
  59 LICENSE AND COPYRIGHT
  60
  61 Copyright (C) 2014  Intel Corporation
  62
  63 This library is free software; you can redistribute it and/or
  64 modify it under the terms of the GNU Lesser General Public
  65 License as published by the Free Software Foundation; either
  66 version 2.1 of the License, or (at your option) any later version.
  67
  68 This library is distributed in the hope that it will be useful,
  69 but WITHOUT ANY WARRANTY; without even the implied warranty of
  70 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  71 Lesser General Public License for more details.
  72
  73 You should have received a copy of the GNU Lesser General Public
  74 License along with this library; if not, write to the Free Software
  75 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  76
  77