Skip to content

Commit

Permalink
First upload to the new independent repository
Browse files Browse the repository at this point in the history
  • Loading branch information
@dberenguer
dberenguer committed Jun 19, 2015
1 parent c2e19e2 commit 3b97f99
Show file tree
Hide file tree
Showing 21 changed files with 2,269 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
This library for Arduino IDE 1.6 implements SWAP on top of any existing
ISM radio as far as the necessary hardware cores exist. Take a look at
our repository containing the cores to see how to port your radio for SWAP.

https://github.com/panStamp/panstamp/wiki

SWAP stands for Simple Wireless Abstract Protocol and is designed to turn
simple wireless nodes into powerful interoperable devices programmable
the Arduino IDE:

https://github.com/panStamp/panstamp/wiki/Simple%20Wireless%20Abstract%20Protocol

panStamp is fully supporting SWAP, which has proven to be a serious
alternative to other oversized and overkilled protocols like Zigbee.
SWAP usually requires less than 8 KB of flash space and less than 1 KB of RAM.

SWAP is not a true MESH technology. However, it is able to implement a good
amount of very different topologies, including star, point-to-point and
mixed coordinated-autonomous cells.
226 changes: 226 additions & 0 deletions commonregs.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
/**
* Copyright (c) 2014 panStamp <contact@panstamp.com>
*
* This file is part of the panStamp project.
*
* panStamp is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* any later version.
*
* panStamp is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with panStamp; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*
* Author: Daniel Berenguer
* Creation date: 07/06/2011
*/

#ifndef _COMMONREGS_H
#define _COMMONREGS_H

#include "swstatus.h"
#include "nvolat.h"
#include "register.h"
#include "register.h"
#include "swap.h"

const void setSysState(uint8_t id, uint8_t *state);
const void setFreqChannel(uint8_t id, uint8_t *channel);
const void setDevAddress(uint8_t id, uint8_t *addr);
const void setNetworkId(uint8_t rId, uint8_t *nId);
const void setTxInterval(uint8_t id, uint8_t *interval);

#define DECLARE_COMMON_CALLBACKS()

/**
* Macros for the definition of common register indexes
*/
#define DEFINE_COMMON_REGINDEX_START() \
enum CUSTOM_REGINDEX \
{ \
REGI_PRODUCTCODE = 0, \
REGI_HWVERSION, \
REGI_FWVERSION, \
REGI_SYSSTATE, \
REGI_FREQCHANNEL, \
REGI_SECUOPTION, \
REGI_PASSWORD, \
REGI_SECUNONCE, \
REGI_NETWORKID, \
REGI_DEVADDRESS, \
REGI_TXINTERVAL,

#define DEFINE_COMMON_REGINDEX_END() };

#define DEFINE_REGINDEX_START() DEFINE_COMMON_REGINDEX_START()
#define DEFINE_REGINDEX_END() DEFINE_COMMON_REGINDEX_END()

/**
* Macro for the definition of registers common to all SWAP devices
*/
#define DEFINE_COMMON_REGISTERS() \
/* Product code */ \
static uint8_t dtProductCode[8] = {(uint8_t)(SWAP_MANUFACT_ID >> 24), (uint8_t)(SWAP_MANUFACT_ID >> 16) , (uint8_t)(SWAP_MANUFACT_ID >> 8), (uint8_t)(SWAP_MANUFACT_ID), \
(uint8_t)(SWAP_PRODUCT_ID >> 24), (uint8_t)(SWAP_PRODUCT_ID >> 16) , (uint8_t)(SWAP_PRODUCT_ID >> 8), (uint8_t)(SWAP_PRODUCT_ID)}; \
REGISTER regProductCode(dtProductCode, sizeof(dtProductCode), NULL, NULL); \
/* Hardware version */ \
static uint8_t dtHwVersion[4] = {(uint8_t)(HARDWARE_VERSION >> 24), (uint8_t)(HARDWARE_VERSION >> 16) , (uint8_t)(HARDWARE_VERSION >> 8), (uint8_t)(HARDWARE_VERSION)}; \
REGISTER regHwVersion(dtHwVersion, sizeof(dtHwVersion), NULL, NULL); \
/* Firmware version */ \
static uint8_t dtFwVersion[4] = {(uint8_t)(FIRMWARE_VERSION >> 24), (uint8_t)(FIRMWARE_VERSION >> 16) , (uint8_t)(FIRMWARE_VERSION >> 8), (uint8_t)(FIRMWARE_VERSION)}; \
REGISTER regFwVersion(dtFwVersion, sizeof(dtFwVersion), NULL, NULL); \
/* System state */ \
REGISTER regSysState(&swap.systemState, sizeof(swap.systemState), NULL, &setSysState); \
/* Frequency channel */ \
REGISTER regFreqChannel(&panstamp.radio.channel, sizeof(panstamp.radio.channel), NULL, &setFreqChannel, SWDTYPE_INTEGER, NVOLAT_FREQ_CHANNEL); \
/* Security option */ \
REGISTER regSecuOption(&swap.security, sizeof(swap.security), NULL, NULL); \
/* Security password (not implemented yet) */ \
static uint8_t dtPassword[1]; \
REGISTER regPassword(dtPassword, sizeof(dtPassword), NULL, NULL); \
/* Security nonce */ \
REGISTER regSecuNonce(&swap.nonce, sizeof(swap.nonce), NULL, NULL); \
/* Network Id */ \
REGISTER regNetworkId(panstamp.radio.syncWord, sizeof(panstamp.radio.syncWord), NULL, &setNetworkId, SWDTYPE_OTHER, NVOLAT_SYNC_WORD); \
/* Device address */ \
REGISTER regDevAddress((uint8_t*)&swap.devAddress, sizeof(swap.devAddress), NULL, &setDevAddress, SWDTYPE_INTEGER, NVOLAT_DEVICE_ADDRESS); \
/* Periodic Tx interval */ \
REGISTER regTxInterval((uint8_t*)&swap.txInterval, sizeof(swap.txInterval), NULL, &setTxInterval, SWDTYPE_INTEGER, NVOLAT_TX_INTERVAL);

/**
* Macros for the declaration of global table of registers
*/
#define DECLARE_REGISTERS_START() \
REGISTER *regTable[] = { \
&regProductCode, \
&regHwVersion, \
&regFwVersion, \
&regSysState, \
&regFreqChannel, \
&regSecuOption, \
&regPassword, \
&regSecuNonce, \
&regNetworkId, \
&regDevAddress, \
&regTxInterval,

#define DECLARE_REGISTERS_END() \
}; \
/* Size of regTable */ \
uint8_t regTableSize = sizeof(regTable)/sizeof(*regTable);

/**
* Macro for the definition of getter/setter functions related to all common registers
*/
#define DEFINE_COMMON_CALLBACKS() \
/** \
* setSysState \
* \
* Set system state \
* \
* 'id' Register ID \
* 'state' New system state \
*/ \
const void setSysState(uint8_t id, uint8_t *state) \
{ \
swap.systemState = state[0]; \
switch(state[0]) \
{ \
case SYSTATE_RESTART: \
/* Send status message before restarting the mote */ \
swap.getRegister(REGI_SYSSTATE)->sendSwapStatus(); \
panstamp.reset(); \
break; \
case SYSTATE_UPGRADE: \
panstamp.goToWirelessBoot(); \
break; \
default: \
break; \
} \
} \
\
/** \
* setFreqChannel \
* \
* Set frequency channel \
* \
* 'id' Register ID \
* 'channel' New channel \
*/ \
const void setFreqChannel(uint8_t id, uint8_t *channel) \
{ \
if (channel[0] != regFreqChannel.value[0]) \
{ \
/* Send status message before entering the new \
frequency channel */ \
SWSTATUS packet = SWSTATUS(regFreqChannel.id, channel, regFreqChannel.length); \
packet.send(); \
/* Update register value */ \
panstamp.radio.setChannel(channel[0]); \
/* Restart device */ \
panstamp.reset(); \
} \
} \
\
\
/** \
* setDevAddress \
* \
* Set device address \
* \
* 'id' Register ID \
* 'addr' New device address \
*/ \
const void setDevAddress(uint8_t id, uint8_t *addr) \
{ \
/* Send status before setting the new address */ \
SWSTATUS packet = SWSTATUS(regDevAddress.id, addr, regDevAddress.length); \
packet.send(); \
/* Set new SWAP address. BE to LE conversion */ \
regDevAddress.setValueFromBeBuffer(addr); \
/* Update register value */ \
panstamp.radio.setDevAddress(addr[regDevAddress.length-1]); \
} \
\
/** \
* setNetworkId \
* \
* Set network id \
* \
* 'rId' Register ID \
* 'nId' New network id \
*/ \
const void setNetworkId(uint8_t rId, uint8_t *nId) \
{ \
if ((nId[0] != regNetworkId.value[0]) || \
(nId[1] != regNetworkId.value[1])) \
{ \
/* Send status before taking the new network ID */ \
SWSTATUS packet = SWSTATUS(regNetworkId.id, nId, regNetworkId.length); \
packet.send(); \
/* Update register value */ \
panstamp.radio.setSyncWord(nId); \
} \
} \
/** \
* setTxInterval \
* \
* Set periodic Tx interval \
* \
* 'id' Register ID \
* 'interval' New interval (in seconds) \
*/ \
const void setTxInterval(uint8_t id, uint8_t *interval) \
{ \
/* Set new Tx interval. BE to LE conversion */ \
regTxInterval.setValueFromBeBuffer(interval); \
}
#endif

44 changes: 44 additions & 0 deletions config.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/**
* Copyright (c) 2011 panStamp <contact@panstamp.com>
*
* This file is part of the panStamp project.
*
* panStamp is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* any later version.
*
* panStamp is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with panStamp; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*
* Author: Daniel Berenguer
* Creation date: 06/02/2012
*/

#ifndef _CONFIG_H
#define _CONFIG_H

/**
* Repeater options
*/
// Amount of transactions to be saved for evaluation before repeating a packet
// Maximum depth = 255
#define REPEATER_TABLE_DEPTH 20
// Expiration time (in ms) for any transaction
#define REPEATER_EXPIRATION_TIME 2000

/**
* Addressing schema
*/
// Extended addresses (2 bytes)
//#define SWAP_EXTENDED_ADDRESS 1

#endif

40 changes: 40 additions & 0 deletions datatypes.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/**
* Copyright (c) 2011 panStamp <contact@panstamp.com>
*
* This file is part of the panStamp project.
*
* panStamp is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* any later version.
*
* panStamp is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with panStamp; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*
* Author: Daniel Berenguer
* Creation date: 06/27/2013
*/

#ifndef _DATATYPES_H
#define _DATATYPES_H

#include <stdint.h>
#include "config.h"

/**
* SWDTYPE : Type of data contained in SWAP register
*/
typedef enum SWDTYPE/* : unsigned char*/
{
SWDTYPE_INTEGER = 0, // Register containing a single 1-to-4 byte integer
SWDTYPE_OTHER // Other type of register contents
} SWDTYPE;
#endif

9 changes: 9 additions & 0 deletions library.properties
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name=SWAP
version=1.0.0
author=panStamp
maintainer=panStamp <contact@panstamp.com>
sentence=Simple Wireless Abstract Protocol (SWAP) library for ISM radios
paragraph=Simple Wireless Abstract Protocol (SWAP) library for ISM radios
category=Communication
url=https://github.com/panStamp/swap.git
architectures=*
53 changes: 53 additions & 0 deletions nvolat.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
/**
* Copyright (c) 2014 panStamp <contact@panstamp.com>
*
* This file is part of the panStamp project.
*
* panStamp is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* any later version.
*
* panStamp is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with panStamp; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*
* Author: Daniel Berenguer
* Creation date: 07/04/2014
*/

#ifndef _NVOLAT_H
#define _NVOLAT_H

#include "config.h"

/**
* EEPROM/Infomem addresses
*/
#define NVOLAT_FREQ_CHANNEL 0x00 // 1-byte register
#define NVOLAT_NOT_USED 0x01 // 1-byte register
#define NVOLAT_SYNC_WORD 0x02 // 2-byte register
#define NVOLAT_DEVICE_ADDR 0x04 // 1 or 2 byte register
#define NVOLAT_TX_INTERVAL 0x06 // 2-byte register
#define NVOLAT_SIGNATURE 0x08 // 2-byte register
#define NVOLAT_CARRIER_FREQ 0x0A // 3-byte register
#define NVOLAT_FIRST_CUSTOM 0x20

// Signature
#define NVOLAT_SIGNATURE_HIGH 0xAB
#define NVOLAT_SIGNATURE_LOW 0xCD

// Extended address
#ifdef SWAP_EXTENDED_ADDRESS
#define NVOLAT_DEVICE_ADDRESS NVOLAT_DEVICE_ADDR
#else
#define NVOLAT_DEVICE_ADDRESS NVOLAT_DEVICE_ADDR + 1
#endif

#endif
Loading

0 comments on commit 3b97f99

Please sign in to comment.