Mario Bambagini
A simple wireless protocol to let my examples communicate each other. ssWi stands for Shared Slotted Wireless protocol
Dependents: rover_car rover_pc supervisor watering_unit ... more
This library aims at implementing a simple communication protocol among nodes, abstracting from the hardware. The name ssWi stands for Shared Slotted Wireless. Wireless is part of the name, even though the library abstracts from the hardware, as the first version was entirely focused on the XBee modules and then the name has not been changed.
The communication channel is represented by ssWiChannel, an abstract class which models the channel that the transceivers access to. The concrete classes must implement the functions: init, read and write. The protocol automatically sends and receives data through the selected channel, exploiting the operting system timers. Addresses are not considered as the communication lays on broadcast transmissions.
The protocol provides the ssWiPort abstraction which is like memory areas shared among all the connected nodes. Reading from one port lets the node retrieve the last written value from the other nodes. Writing on one port means sending such value to other nodes.
Objects instantiated from ssWiSocket are the interface for allowing nodes to access the protocol ports.
TODO:
- improve the parsing of the received messages
- communication tests with many nodes (so far, only 2 nodes have been tested)
Diff: ssWiSocket.hpp
- Revision:
- 4:dbbf82c966c2
- Parent:
- 0:cc7218c5e5f7
- Child:
- 7:ca87b7287af9
--- a/ssWiSocket.hpp Thu Sep 06 12:11:52 2012 +0000
+++ b/ssWiSocket.hpp Fri Sep 07 23:02:04 2012 +0000
@@ -1,36 +1,48 @@
+/** \file ssWiSockert.hpp
+ * \brief Header for the communcation socket
+ *
+ */
+
#ifndef __SHARED_SLOTTED_WIRELESS_SOCKET_HPP__
#define __SHARED_SLOTTED_WIRELESS_SOCKET_HPP__
-#include "ssWiPort.hpp"
+
+#include "ssWiTypes.hpp"
+
+/** \brief Socket to communciate through ssWi
+ *
+ * It is not possible to instanciate directly a ssWiSocket, use the static
+ * method createSocket
+ */
class ssWiSocket
{
-
- friend class ssWi;
-
- //ssWi* w;
- ssWiPort* p;
+ /** \brief Port identifier */
+ PortID _id;
- //ssWiSocket(ssWi* w, ssWiPort* p) {
- ssWiSocket(ssWiPort* p) {
- //this->w = w;
- this->p = p;
- }
+ /** \brief Hidden constructor */
+ ssWiSocket(PortID id) : _id(id) {}
public:
- PortValue read () {
- return p->getRXValue();
- }
- void write (PortValue value) {
- p->setTXValue(value);
- }
+ /** \brief create a new socket
+ *
+ * If the network is not inizialized yet, the method returns false
+ *
+ * \param id port identifier to connect the socket with
+ */
+ static ssWiSocket* createSocket(PortID id);
-/*
- bool close() {
- w->unsetPort();
- }
-*/
+ /** \brief read the last value read through the network on such socket
+ */
+ PortValue read ();
+
+ /** \brief write a new value to be sent through the socket
+ *
+ * \param value value to be sent
+ */
+ void write (PortValue value);
+
};