
..
CSharp	Add arduino libraries and script for focusing automatically	9 years ago
Documentation	Add arduino libraries and script for focusing automatically	9 years ago
Examples	Add arduino libraries and script for focusing automatically	9 years ago
Tools	Add arduino libraries and script for focusing automatically	9 years ago
CmdMessenger.cpp	Add arduino libraries and script for focusing automatically	9 years ago
CmdMessenger.h	Add arduino libraries and script for focusing automatically	9 years ago
LICENSE	Add arduino libraries and script for focusing automatically	9 years ago
README.markdown	Add arduino libraries and script for focusing automatically	9 years ago
keywords.txt	Add arduino libraries and script for focusing automatically	9 years ago

CmdMessenger v3.6

A serial messaging library for the Arduino and .NET/Mono platform

Introduction

CmdMessenger is a messaging library for the Arduino Platform (and .NET/Mono platform). Ituses the serial port as it's transport layer**

The message format is:

Cmd Id, param 1, [...] , param N;

Although the field separator ',' and command separator ';' can be changed

The library can

both send and receive of commands
Both write and read multiple arguments
Both write and read all primary data types
Attach callback functions any received command

The library supports any primary data types, and zero to many multiple arguments. Arguments can either be sent in plain text (to be human readable) or in binary form (to be efficient).

With version 3.x also comes a full implementation of the toolkit in C#, which runs both in Mono (http://monodevelop.com/Download) and Visual Studio (http://www.microsoft.com/visualstudio/eng#downloads) This allows for full 2-way communication between the arduino controller and the PC.

** but it could easily be modified to work over Bluetooth or a web interface.

Requirements

Arduino IDE Version 1.0.5 or later*

* Earlier versions of the Arduino IDE may work but have not been tested.

Getting Started

Get to know the library, by trying the examples,from simple to complex:

Receive

The 1st example will make the PC toggle the integrated led on the Arduino board.

On the Arduino side, it demonstrates how to:
- Define commands
- Set up a serial connection
- Receive a command with a parameter from the PC
On the PC side, it demonstrates how to:
- Define commands
- Set up a serial connection
- Send a command with a parameter to the Arduino

SentandReceive

This example expands the previous Receive example. The Arduino will now send back a status. On the Arduino side,

it demonstrates how to:
- Handle received commands that do not have a function attache
- Send a command with a parameter to the PC
On the PC side, it demonstrates how to:
- Handle received commands that do not have a function attached
- Receive a command with a parameter from the Arduino

SendandReceiveArguments

This example expands the previous SendandReceive example. The Arduino will now receive multiple and sent multiple float values.

On the arduino side, it demonstrates how to:
- Return multiple types status
- Receive multiple parameters,
- Send multiple parameters
- Call a function periodically
On the PC side, it demonstrates how to:
- Send multiple parameters, and wait for response
- Receive multiple parameters
- Add logging events on data that has been sent or received
SendandReceiveBinaryArguments

This example expands the previous SendandReceiveArguments example. The Arduino will receive and send multiple Binary values, demonstrating that this is more efficient way of communication.
On the Arduino side, it demonstrates how to:
- Send binary parameters
- Receive binary parameters
On the PC side, it demonstrates how to:
- Receive multiple binary parameters,
- Send multiple binary parameters
- How callback events can be handled while the main program waits
- How to calculate milliseconds, similar to Arduino function Millis()

DataLogging

This example expands the previous SendandReceiveArguments example. The PC will now send a start command to the Arduino, and wait for a response from the Arduino. The Arduino will start sending analog data which the PC will plot in a chart

This example shows how to :

Use CmdMessenger in combination with GUI applications
Use CmdMessenger in combination with ZedGraph
Use the StaleGeneralStrategy
ArduinoController

This example expands the SendandReceiveArguments example. The PC will now sends commands to the Arduino when the trackbar is pulled. Every TrackBarChanged events will queue a message to the Arduino to set the blink speed of the internal / pin 13 LED

This example shows how to :

use CmdMessenger in combination with GUI applications
use CmdMessenger in combination with ZedGraph
Send queued commandssds
use the CollapseCommandStrategy

TemperatureControl

This example expands the previous ArduinoController example. The PC will now send a start command to the Arduino, and wait for a response from the Arduino. The Arduino will start sending temperature data and the heater steering value data which the PC will plot in a chart. With a slider we can set the goal temperature, which will make the PID software on the controller adjust the setting of the heater. This example shows how to design a responsive performance UI that sends and receives commands

Send queued commands
Add queue strategies

ConsoleShell

This example shows how to use CmdMessenger as a shell, and communicate with it using the Serial Console This example is different from the others:

there is no PC counterpart
it will only receive commands, instead of sending

commands it will use Serial.PrintBelow is an example of interacting with the sample:

 Available commands
 0;                  - This command list
 1,<led state>;      - Set led. 0 = off, 1 = on
 2,<led brightness>; - Set led brighness. 0 - 1000
 3;                  - Show led state

Command> 3;

Led status: on
Led brightness: 500

Command> 2,1000;

 Led status: on
 Led brightness: 1000

Command> 1,0;

 Led status: off
 Led brightness: 1000

All samples are heavily documented and should be self explanatory.

Open the Example sketch in the Arduino IDE and compile and upload it to your board.
Open de CmdMessenger.sln solution in Visual Studio or Mono Develop/Xamarin Studio
Set example project with same name as the Arduino sketch as start-up project, and run
Enjoy!

Trouble shooting

If the PC and Arduino are not able to connect, chances are that either the selected port on the PC side is not correct or that the Arduino and PC are not at the same baud rate. Try it out by typing commands into the Arduino Serial Monitor, using the ConsoleShell
Some boards (e.g. Sparkfun Pro Micro) need DtrEnable set to be true.
If the port and baud rate are correct but callbacks are not being invoked, try looking at logging of sent and received data. See the SendandReceiveArguments project for an example.
If you have a problem that is hard to pinpoint, use the CommandMessengerTests testsuite. This project runs unit tests on several parts on the mayor parts of the CmdMessenger library. Note that the primary function is not to serve as an example, so the code may be less documented and clean as the example projects.

Notes

An example for use with Max5 / MaxMSP was included up until version 2. (it can still be found here https://github.com/dreamcat4/CmdMessenger). Since we have not been able to check it wil Max/MaxMSP, the example was removed.

Changelog