TSP: The Transport Sample Protocol



BB Tools Command Lines
[The BB ToolsTSP Applications]

The Blackboard tools command line interface. More...

Collaboration diagram for BB Tools Command Lines:

The Blackboard tools command line interface.

bb_tools is a command line tool with a "BusyBox"-like design (http://www.busybox.net). bb_tools is the 'main' command which may be used with its generic interface of may be called (using symlink) with a different name such that the first arg may be ommitted. Any of those tools may be launch without argument and will provide a command line option summary (if needed).

bb_tools [bb_tools_opts] <bb_tools_cmd> [cmd_opts]
The generic bb_tools command.
  • bb_tools_opts the bb_tools generic options which may be
    • -s silent mode (may be used for silent scripting)
    • -v verbose mode
    • -n no newline read mode
bb_help
Display the online help.
bb_read <bbname> <symname>
Read the value of a specified symbol in specified Blackboard.
  • bbname the blackboard name
  • symname the exact name of the Blackboard symbol to read Value of the symbols is printed iff it is printable, non-printable value will given as hexadecimal dump.
bb_write <bbname> <symname> <value>
Write to a BlackBoard symbol variable.
  • bbname the blackboard name
  • symname the blackboard symbol name
  • value the value to be written, the value may be given in decimal or hexadecimal if the 0x prefix is added.
bb_dump <bbname>
Dump the specified BlackBoard.
  • bbname the blackboard name The command will dump all symbols and associated value output may be huge if not filtered.
bb_find <bbname> <labelmatch>
A command line tool used to find a label in the specified BlackBoard.
  • bbname the blackboard name
  • labelmatch the part to find (using a simple strstr(3)) The command will list the name of all symbols found in blackboard that match labelmatch.
bb_check_id <bbname> [<user_specific_value>]
Print out the IPC key used by the specified BlackBoard.
  • bbname the blackboard name
  • user_specific_value an integer, default is getuid(2) This may be used against ipcs(P) values to check if IPC object belongs to a BlackBoard.
bb_destroy <bbname>
Destroy the specified BlackBoard.
  • bbname the blackboard name Note that BlackBoard will effectively be destroyed when the last process detached itself from the BlackBoard.
bb_create <bbname> <ndate> <datazonesize>
  • bbname the blackboard name
  • ndata the number of publishable data in this BlackBoard
  • datazonesize the size of the BlackBoard Data area. Create a BlackBoard with the specified name and sizes.
bb_publish <bbname> <symname> [<symtype>=BB_UINT] [<arraysize>=1]
  • bbname the blackboard name
  • symname the name of the symbol to be published
  • symtype the BlackBoard type of the symbol to be published, default is BB_UINT
  • arraysize the array size of the symbol, default is 1 (i.e. scalar).
bb_synchro_send <bbname>
  • bbname the blackboard name Send a synchro message through the BlackBoard synchro message queue.
bb_synchro_recv <bbname>
  • bbname the blackboard name Receive a synchro message from the BlackBoard synchro message queue.
bb_memset <bbname> <bytevalue>
  • bbname the blackboard name
  • bytevalue the byte value to write to BlackBoard Data Area Fill the BlackBoard data area with bytevalue. This may be used to memset the BlackBoard data area to binary 0, just bb_memset <bbname> 0.
bb_check_version <bbname>
Verify whether if the specified BlackBoard has the same BlackBoard version ID as the bb_tools used.
  • bbname the blackboard name If version do not match YOU SHOULD NOT USE THOSE bb_tools to manipulate this BlackBoard. You should check you BlackBoard library installation too and/or the BlackBoard library version used by the application which created the BlackBoard you are looking at.
Framework Home Page.

Beware !! TSP wave is coming...