XML Message Set

The bsI2CMsgs.xml specification defines the set of messages for BotSense virtual connections exstablished between BotSense clients and raw I²C devices proxied by the bsProxy server.

The I²C messages are terminated between the BotSense client libbsclient_i2c.so shared library or libbsclient_i2c.a static library and the bsProxy plug-in libbsserver_i2c.so interface module DLL.

The message encoding is 8-bit Id-Type-Value (itv). All message fields are packed in big-endian order.

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE netmsgs PUBLIC "-//www.roadnarrows.com//DTD NETMSGS 1.0//EN"
          "http://www.roadnarrows.com/xml/netmsgs/1.0/netmsgs.dtd">

<!--
 - Package: BotSense
 - Module:  bsI2C
 - File:    bsI2CMsgs.xml
 -

/*!
 \file

  $LastChangedDate$
  $Rev$

  \brief Client - bsProxy server raw \h_i2c bus device messages.
  
  \author Robin Knight (robin.knight@roadnarrows.com)
  
 -  \copyright
 -    \h_copy 2010-2017. RoadNarrows LLC.\n
 -    http://www.roadnarrows.com\n
 -    All Rights Reserved
*/

 - Permission is hereby granted, without written agreement and without
 - license or royalty fees, to use, copy, modify, and distribute this
 - software and its documentation for any purpose, provided that
 - (1) The above copyright notice and the following two paragraphs
 - appear in all copies of the source code and (2) redistributions
 - including binaries reproduces these notices in the supporting
 - documentation.   Substantial modifications to this software may be
 - copyrighted by their authors and need not follow the licensing terms
 - described here, provided that the new terms are clearly indicated in
 - all files where they apply.
 -
 - IN NO EVENT SHALL THE AUTHOR, ROADNARROWS LLC, OR ANY MEMBERS/EMPLOYEES
 - OF ROADNARROW LLC OR DISTRIBUTORS OF THIS SOFTWARE BE LIABLE TO ANY
 - PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
 - DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION,
 - EVEN IF THE AUTHORS OR ANY OF THE ABOVE PARTIES HAVE BEEN ADVISED OF
 - THE POSSIBILITY OF SUCH DAMAGE.
 -
 - THE AUTHOR AND ROADNARROWS LLC SPECIFICALLY DISCLAIM ANY WARRANTIES,
 - INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 - FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN
 - "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO
 - PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 -
-->

<netmsgs encoding="itv" endian="big">

  <!-- ........................................................................
    - Meta Data to Tweak Source Generation
    ....................................................................... -->
  <meta>
    <brief>
      BotSense bsProxy server - client raw I2C NetMsgs XML Definition
    </brief>
    <ns>BsI2C</ns>
    <prologue lang="h">
#include "rnr/i2c-dev.h"

#include "botsense/BotSense.h"
    </prologue>
    <epilogue lang="h"></epilogue>
    <prologue lang="c"></prologue>
    <epilogue lang="c"></epilogue>
    <prologue lang="python">
## maximum vector length
NMFVAL_LEN_MAX_VECTOR = nmBase.NMVectorMaxCount
    </prologue>
    <epilogue lang="python"></epilogue>
  </meta>

  <!-- ........................................................................
    - Extended Field Types (Optional)
    ....................................................................... -->
  <field_types>
  </field_types>


  <!-- ........................................................................
    - Message Definitions
    ....................................................................... -->
  <msg_types>

    <!-- I2C Read Request -->
    <msgdef msgid="ReqRead">
      <fielddef fname="addr" ftype="u16">
      </fielddef>
      <fielddef fname="readlen" ftype="u8">
        <min>1</min>
        <max>NMFVAL_LEN_MAX_VECTOR</max>
      </fielddef>
    </msgdef>

    <!-- I2C Transaction Request -->
    <msgdef msgid="ReqTrans">
      <fielddef fname="addr" ftype="u16">
      </fielddef>
      <fielddef fname="writebuf" ftype="u8[]" />
      <fielddef fname="readlen" ftype="u8">
        <min>1</min>
        <max>NMFVAL_LEN_MAX_VECTOR</max>
      </fielddef>
    </msgdef>

    <!-- I2C Read/Transaction Response -->
    <msgdef msgid="RspRead">
      <fielddef fname="readbuf" ftype="u8[]" />
    </msgdef>

    <!-- I2C Write Request -->
    <msgdef msgid="ReqWrite">
      <fielddef fname="addr" ftype="u16">
      </fielddef>
      <fielddef fname="writebuf" ftype="u8[]" />
    </msgdef>

    <!-- I2C Write Response -->
    <msgdef msgid="RspWrite">
      <fielddef fname="byteswritten" ftype="u8" />
    </msgdef>

    <!-- I2C Scan Request -->
    <msgdef msgid="ReqScan">
    </msgdef>

    <!-- I2C Scan Response -->
    <msgdef msgid="RspScan">
      <fielddef fname="scan" ftype="u16[]" />
    </msgdef>

  </msg_types>

</netmsgs>