Defines

mComm_config.h File Reference

mComm Configuration! Main configuration file for the mComm module. More...

#include "mComm_optionsForConfig.h"
Include dependency graph for mComm_config.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define MCOMM_INPUTBUFFER_SIZE   11
#define MCOMM_ENABLE_NVM_ACCESS
#define MCOMM_ENABLE_STREAM
#define MCOMM_STREAM_STORED_IN_RAM
#define MCOMM_ENABLE_CUSTOM_OPCODE
#define MCOMM_CUSTOM_CALLBACK   mComm_CustomCallback
#define MCOMM_CUSTOM_PROCESS   mComm_CustomProcess
#define MCOMM_CUSTOM_READ_ITERATOR   mComm_ramReadIterator
#define MCOMM_CUSTOM_WRITE_ITERATOR   mComm_CustomWriteIterator
#define MCOMM_CUSTOM_VARIABLE   mComm_GUICustomVariable
#define MCOMM_UART_1WAY_MODULE   MCOMM_UART_HARDWARE_MODULE
#define MCOMM_UART_SOFT_TXPORT   PORTA
#define MCOMM_UART_SOFT_TXTRIS   TRISA
#define MCOMM_UART_SOFT_TXPIN   5
#define MCOMM_UART_1WAY_OUTPUT   MCOMM_UART_1WAY_DECIMAL
#define MCOMM_UART_1WAY_DELIMITER   ','
#define MCOMM_UART_1WAY_OUT_STATE
#define MCOMM_UART_1WAY_OUT_TOGGLE
#define MCOMM_UART_1WAY_OUT_SLIDER
#define MCOMM_UART_1WAY_OUT_READING
#define MCOMM_I2C_ADDRESS   0xA0
#define MCOMM_I2C_ADDRESS_BUSY   0xA2
#define MCOMM_I2C_SSPSTAT   SSPSTAT
#define MCOMM_I2C_SSPCON1   SSPCON1
#define MCOMM_I2C_SSPCON2   SSPCON2
#define MCOMM_I2C_SSPCON3   SSPCON3
#define MCOMM_I2C_SSPMSK   SSPMSK
#define MCOMM_I2C_SSPADD   SSPADD
#define MCOMM_I2C_SSPBUF   SSPBUF
#define MCOMM_I2C_CKP   SSPCON1bits.CKP
#define MCOMM_I2C_RnW   SSPSTATbits.R_nW
#define MCOMM_I2C_DnA   SSPSTATbits.D_nA
#define MCOMM_I2C_STOP   SSPSTATbits.P
#define MCOMM_I2C_SSPOV   SSPCON1bits.SSPOV
#define MCOMM_I2C_WCOL   SSPCON1bits.WCOL
#define MCOMM_I2C_SSPIE   PIE1bits.SSPIE
#define MCOMM_I2C_SSPIF   PIR1bits.SSPIF
#define MCOMM_I2C_PEIE   INTCONbits.PEIE
#define MCOMM_SPI_SS_PIN   RB5
#define MCOMM_SPI_ADDRESS   0xA0
#define MCOMM_SPI_SSPSTAT   SSPSTAT
#define MCOMM_SPI_SSPCON1   SSPCON1
#define MCOMM_SPI_SSPCON3   SSPCON3
#define MCOMM_SPI_SSPBUF   SSPBUF
#define MCOMM_SPI_WCOL   SSPCON1bits.WCOL
#define MCOMM_SPI_SSPOV   SSPCON1bits.SSPOV
#define MCOMM_SPI_SSPIE   PIE1bits.SSPIE
#define MCOMM_SPI_SSPIF   PIR1bits.SSPIF
#define MCOMM_SPI_PEIE   INTCONbits.PEIE
#define MCOMM_SPI_IOCIF   INTCONbits.IOCIF
#define MCOMM_UART_RCREG   RCREG
#define MCOMM_UART_TXREG   TXREG
#define MCOMM_UART_TXSTA   TXSTA
#define MCOMM_UART_RCSTA   RCSTA
#define MCOMM_UART_BAUDCON   BAUDCON
#define MCOMM_UART_SPBRGL   SPBRGL
#define MCOMM_UART_SPBRGH   SPBRGH
#define MCOMM_UART_TXIF   PIR1bits.TXIF
#define MCOMM_UART_OERR   RCSTAbits.OERR
#define MCOMM_UART_CREN   RCSTAbits.CREN
#define MCOMM_UART_BRGH   TXSTAbits.BRGH
#define MCOMM_UART_BRG16   BAUDCONbits.BRG16
#define MCOMM_UART_SPEN   RCSTAbits.SPEN
#define MCOMM_UART_TXEN   TXSTAbits.TXEN
#define MCOMM_UART_PEIE   INTCONbits.PEIE
#define MCOMM_UART_RCIF   PIR1bits.RCIF
#define MCOMM_UART_RCIE   PIE1bits.RCIE
#define MCOMM_STREAM_ADDR   (uint8_t*)&mComm_stream
#define MCOMM_STREAMCONFIG_ADDR   (uint8_t*)&mComm_streamConfig
#define MCOMM_CUSTOM_VAR_ADDR   ,(uint8_t*)&MCOMM_CUSTOM_VARIABLE
#define MCOMM_STREAM_SIZE   7
#define MCOMM_STREAM_VALUE0   { (uint8_t*)&mTouch_stateMask, MTOUCH_STATEMASK_BYTES }
#define MCOMM_STREAM_VALUE1   { (uint8_t*)&mTouch_sensorData, 2*MTOUCH_NUMBER_SENSORS }
#define MCOMM_STREAM_VALUE2   { (uint8_t*)&mTouch_average, 2*MTOUCH_NUMBER_SENSORS }
#define MCOMM_CONFIG_LIT_SIZE   10
#define MCOMM_CONFIG_LIT_INIT
#define MCOMM_CONFIG_ADDR_SIZE   9
#define MCOMM_CONFIG_ADDR_INIT
UART-PC Communications Setup (mComm_config.h)

These configuration options define if and how the mTouch framework is to communicate with a PC.

Attention:
It is highly recommended that you look at the raw data output to determine how the system is behaving and where to place the thresholds.
#define MCOMM_TYPE
 Defines one of four available communication options: MCOMM_UART_ONE_WAY, MCOMM_UART_TWO_WAY, MCOMM_I2C_TWO_WAY, and MCOMM_SPI_TWO_WAY.
#define MCOMM_UART_BAUDRATE
 If UART is being used, this defines the communication baud rate.

Detailed Description

mComm Configuration! Main configuration file for the mComm module.

Definition in file mComm_config.h.


Define Documentation

#define MCOMM_CONFIG_ADDR_INIT
Value:
{                                                       \
                                            (uint8_t*) MCOMM_STREAMCONFIG_ADDR,                 \
                                            (uint8_t*) MCOMM_STREAM_ADDR,                       \
                                            (uint8_t*) MTOUCH_EEPROM_START_ADR,                 \
                                            (uint8_t*) &mTouch_stateMask,                       \
                                            (uint8_t*) &mTouch_sensorData,                      \
                                            (uint8_t*) &mTouch_average,                         \
                                            (uint8_t*) MCOMM_SLIDER_ADR,                        \
                                            (uint8_t*) MCOMM_TOGGLE_ADR                         \
                                            MCOMM_CUSTOM_VAR_ADDR                               \
                                        }

Definition at line 455 of file mComm_config.h.

#define MCOMM_CONFIG_ADDR_SIZE   9

Definition at line 454 of file mComm_config.h.

#define MCOMM_CONFIG_LIT_INIT
Value:
{                                                       \
                                            MCOMM_CONFIGURATION_BYTE,                           \
                                            MCOMM_INPUTBUFFER_SIZE,                             \
                                            MCOMM_STREAM_SIZE,                                  \
                                            MTOUCH_NUMBER_SENSORS,                              \
                                            MTOUCH_CONFIGURATION_BYTE,                          \
                                            MTOUCH_EEPROM_POW2_SIZE,                            \
                                            MTOUCH_FRAMEWORK_VERSION,                           \
                                            MTOUCH_SOFTWARE_VERSION,                            \
                                            MTOUCH_HARDWARE_VERSION,                            \
                                            MTOUCH_BOARD_ID                                     \
                                        }

Definition at line 440 of file mComm_config.h.

#define MCOMM_CONFIG_LIT_SIZE   10

Definition at line 439 of file mComm_config.h.

#define MCOMM_CUSTOM_CALLBACK   mComm_CustomCallback

Definition at line 220 of file mComm_config.h.

#define MCOMM_CUSTOM_PROCESS   mComm_CustomProcess

Definition at line 224 of file mComm_config.h.

#define MCOMM_CUSTOM_READ_ITERATOR   mComm_ramReadIterator

Definition at line 227 of file mComm_config.h.

#define MCOMM_CUSTOM_VAR_ADDR   ,(uint8_t*)&MCOMM_CUSTOM_VARIABLE

Definition at line 374 of file mComm_config.h.

#define MCOMM_CUSTOM_VARIABLE   mComm_GUICustomVariable

Definition at line 234 of file mComm_config.h.

#define MCOMM_CUSTOM_WRITE_ITERATOR   mComm_CustomWriteIterator

Definition at line 231 of file mComm_config.h.

#define MCOMM_ENABLE_CUSTOM_OPCODE

Definition at line 165 of file mComm_config.h.

#define MCOMM_ENABLE_NVM_ACCESS

Definition at line 132 of file mComm_config.h.

#define MCOMM_ENABLE_STREAM

Definition at line 147 of file mComm_config.h.

#define MCOMM_I2C_ADDRESS   0xA0

Definition at line 311 of file mComm_config.h.

#define MCOMM_I2C_ADDRESS_BUSY   0xA2

Definition at line 312 of file mComm_config.h.

#define MCOMM_I2C_CKP   SSPCON1bits.CKP

Definition at line 320 of file mComm_config.h.

#define MCOMM_I2C_DnA   SSPSTATbits.D_nA

Definition at line 322 of file mComm_config.h.

#define MCOMM_I2C_PEIE   INTCONbits.PEIE

Definition at line 328 of file mComm_config.h.

#define MCOMM_I2C_RnW   SSPSTATbits.R_nW

Definition at line 321 of file mComm_config.h.

#define MCOMM_I2C_SSPADD   SSPADD

Definition at line 318 of file mComm_config.h.

#define MCOMM_I2C_SSPBUF   SSPBUF

Definition at line 319 of file mComm_config.h.

#define MCOMM_I2C_SSPCON1   SSPCON1

Definition at line 314 of file mComm_config.h.

#define MCOMM_I2C_SSPCON2   SSPCON2

Definition at line 315 of file mComm_config.h.

#define MCOMM_I2C_SSPCON3   SSPCON3

Definition at line 316 of file mComm_config.h.

#define MCOMM_I2C_SSPIE   PIE1bits.SSPIE

Definition at line 326 of file mComm_config.h.

#define MCOMM_I2C_SSPIF   PIR1bits.SSPIF

Definition at line 327 of file mComm_config.h.

#define MCOMM_I2C_SSPMSK   SSPMSK

Definition at line 317 of file mComm_config.h.

#define MCOMM_I2C_SSPOV   SSPCON1bits.SSPOV

Definition at line 324 of file mComm_config.h.

#define MCOMM_I2C_SSPSTAT   SSPSTAT

Definition at line 313 of file mComm_config.h.

#define MCOMM_I2C_STOP   SSPSTATbits.P

Definition at line 323 of file mComm_config.h.

#define MCOMM_I2C_WCOL   SSPCON1bits.WCOL

Definition at line 325 of file mComm_config.h.

#define MCOMM_INPUTBUFFER_SIZE   11

Definition at line 126 of file mComm_config.h.

#define MCOMM_SPI_ADDRESS   0xA0

Definition at line 331 of file mComm_config.h.

#define MCOMM_SPI_IOCIF   INTCONbits.IOCIF

Definition at line 341 of file mComm_config.h.

#define MCOMM_SPI_PEIE   INTCONbits.PEIE

Definition at line 340 of file mComm_config.h.

#define MCOMM_SPI_SS_PIN   RB5

Definition at line 330 of file mComm_config.h.

#define MCOMM_SPI_SSPBUF   SSPBUF

Definition at line 335 of file mComm_config.h.

#define MCOMM_SPI_SSPCON1   SSPCON1

Definition at line 333 of file mComm_config.h.

#define MCOMM_SPI_SSPCON3   SSPCON3

Definition at line 334 of file mComm_config.h.

#define MCOMM_SPI_SSPIE   PIE1bits.SSPIE

Definition at line 338 of file mComm_config.h.

#define MCOMM_SPI_SSPIF   PIR1bits.SSPIF

Definition at line 339 of file mComm_config.h.

#define MCOMM_SPI_SSPOV   SSPCON1bits.SSPOV

Definition at line 337 of file mComm_config.h.

#define MCOMM_SPI_SSPSTAT   SSPSTAT

Definition at line 332 of file mComm_config.h.

#define MCOMM_SPI_WCOL   SSPCON1bits.WCOL

Definition at line 336 of file mComm_config.h.

#define MCOMM_STREAM_ADDR   (uint8_t*)&mComm_stream

Definition at line 362 of file mComm_config.h.

#define MCOMM_STREAM_SIZE   7

Definition at line 400 of file mComm_config.h.

#define MCOMM_STREAM_STORED_IN_RAM

Definition at line 152 of file mComm_config.h.

#define MCOMM_STREAM_VALUE0   { (uint8_t*)&mTouch_stateMask, MTOUCH_STATEMASK_BYTES }

Definition at line 407 of file mComm_config.h.

#define MCOMM_STREAM_VALUE1   { (uint8_t*)&mTouch_sensorData, 2*MTOUCH_NUMBER_SENSORS }

Definition at line 408 of file mComm_config.h.

#define MCOMM_STREAM_VALUE2   { (uint8_t*)&mTouch_average, 2*MTOUCH_NUMBER_SENSORS }

Definition at line 409 of file mComm_config.h.

#define MCOMM_STREAMCONFIG_ADDR   (uint8_t*)&mComm_streamConfig

Definition at line 363 of file mComm_config.h.

#define MCOMM_UART_1WAY_DELIMITER   ','

Definition at line 277 of file mComm_config.h.

#define MCOMM_UART_1WAY_MODULE   MCOMM_UART_HARDWARE_MODULE

Definition at line 260 of file mComm_config.h.

#define MCOMM_UART_1WAY_OUT_READING

Definition at line 296 of file mComm_config.h.

#define MCOMM_UART_1WAY_OUT_SLIDER

Definition at line 294 of file mComm_config.h.

#define MCOMM_UART_1WAY_OUT_STATE

Definition at line 292 of file mComm_config.h.

#define MCOMM_UART_1WAY_OUT_TOGGLE

Definition at line 293 of file mComm_config.h.

#define MCOMM_UART_1WAY_OUTPUT   MCOMM_UART_1WAY_DECIMAL

Definition at line 276 of file mComm_config.h.

#define MCOMM_UART_BAUDCON   BAUDCON

Definition at line 347 of file mComm_config.h.

#define MCOMM_UART_BRG16   BAUDCONbits.BRG16

Definition at line 354 of file mComm_config.h.

#define MCOMM_UART_BRGH   TXSTAbits.BRGH

Definition at line 353 of file mComm_config.h.

#define MCOMM_UART_CREN   RCSTAbits.CREN

Definition at line 352 of file mComm_config.h.

#define MCOMM_UART_OERR   RCSTAbits.OERR

Definition at line 351 of file mComm_config.h.

#define MCOMM_UART_PEIE   INTCONbits.PEIE

Definition at line 357 of file mComm_config.h.

#define MCOMM_UART_RCIE   PIE1bits.RCIE

Definition at line 359 of file mComm_config.h.

#define MCOMM_UART_RCIF   PIR1bits.RCIF

Definition at line 358 of file mComm_config.h.

#define MCOMM_UART_RCREG   RCREG

Definition at line 343 of file mComm_config.h.

#define MCOMM_UART_RCSTA   RCSTA

Definition at line 346 of file mComm_config.h.

#define MCOMM_UART_SOFT_TXPIN   5

Definition at line 267 of file mComm_config.h.

#define MCOMM_UART_SOFT_TXPORT   PORTA

Definition at line 265 of file mComm_config.h.

#define MCOMM_UART_SOFT_TXTRIS   TRISA

Definition at line 266 of file mComm_config.h.

#define MCOMM_UART_SPBRGH   SPBRGH

Definition at line 349 of file mComm_config.h.

#define MCOMM_UART_SPBRGL   SPBRGL

Definition at line 348 of file mComm_config.h.

#define MCOMM_UART_SPEN   RCSTAbits.SPEN

Definition at line 355 of file mComm_config.h.

#define MCOMM_UART_TXEN   TXSTAbits.TXEN

Definition at line 356 of file mComm_config.h.

#define MCOMM_UART_TXIF   PIR1bits.TXIF

Definition at line 350 of file mComm_config.h.

#define MCOMM_UART_TXREG   TXREG

Definition at line 344 of file mComm_config.h.

#define MCOMM_UART_TXSTA   TXSTA

Definition at line 345 of file mComm_config.h.