Zigbee Module Examples

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
example_write_nonvolatile_memory.c File Reference
Module Interface Examples

Resets Module, prompts the user for which NV item to write (1-6) and writes test data to that location. More...

`#include "../HAL/hal.h"`
`#include "../ZM/module.h"`
`#include "../Common/utilities.h"`
`#include "../ZM/module_errors.h"`
`#include "../ZM/zm_phy_spi.h"`
`#include <stdint.h>`

#define | NO_CHARACTER_RECEIVED 0xFF
moduleResult_t | result = MODULE_SUCCESS
uint8_t | zmBuf [ZIGBEE_MODULE_BUFFER_SIZE]
volatile char | command
uint8_t | dataToWrite [16] = "*TESLA CONTROLS*"
void(* | debugConsoleIsr )(int8_t)
uint8_t | getWhichNvItemToWrite ()
void | handleDebugConsoleInterrupt (int8_t rxByte)
int | main (void)

## Detailed Description

Resets Module, prompts the user for which NV item to write (1-6) and writes test data to that location.

The Module supports six NV storage buffers (named "NV Items"). 1-4 are 2 bytes each; 5 & 6 are 16 bytes each. These NV items are stored in the Module's flash memory and can be used for non-volatile storage.

See also:
  example_read_nonvolatile_memory.c

Rev:
  1642

Author:
  dsmith

Date:
  2012-10-31 11:17:04 -0700 (Wed, 31 Oct 2012)

# Support

Please refer to the wiki at www.anaren.com/air-wiki-zigbee for more information. Additional support is available via email at the following addresses:

- Questions on how to use the product: AIR@a.nosp@m.nare.nosp@m.n.com
- Feature requests, comments, and improvements: featu.nosp@m.rere.nosp@m.quest.nosp@m.s@te.nosp@m.slaco.nosp@m.ntro.nosp@m.ls.co.nosp@m.m
- Consulting engagements: sales.nosp@m.@tes.nosp@m.lacon.nosp@m.trol.nosp@m.s.com

# License

Copyright (c) 2012 Tesla Controls. All rights reserved. This Software may only be used with an Anaren A2530E24AZ1, A2530E24CZ1, A2530R24AZ1, or A2530R24CZ1 module. Redistribution and use in source and binary forms, with or without modification, are subject to the Software License Agreement in the file "anaren_eula.txt"

YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANAREN MICROWAVE OR TESLA CONTROLS BE LIABLE OR OBLIGATED UNDER CONTRACT, NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSE INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.

## Function Documentation

uint8_t getWhichNvItemToWrite | ( |  | ) |

Prompt the user to enter the number of an NV item. Blocking wait until user enters a valid number.

Returns:
  which NV item the user selected (1-6), or NO_CHARACTER_RECEIVED if none.

void handleDebugConsoleInterrupt | ( | int8_t | rxByte | ) |

Method to handle bytes received on the debug console. This gets called by the ISR in the hal file since we set the debugConsoleIsr function pointer (in hal file) to point to this function.

## Variable Documentation

volatile char command

The character the user entered. Must be volatile or else may be optimized out

void(* debugConsoleIsr)(int8_t)

function pointer (in hal file) for the function that gets called when a byte is received on the debug console.

    This is a function pointer for the Interrupt Service Routine called when a debug console

character is received. To use it, declare it with `extern void (*debugConsoleIsr)(int8_t);` and then point it to a function you created, e.g. `debugConsoleIsr =` and your function handleDebugConsoleInterrupt() will be called when a byte is received on the debug serial port. Obviously your handleDebugConsoleInterrupt must have the same method signature as the function pointer. In other words, your function should be declared as: void handleDebugConsoleInterrupt(int8_t);

    This is a function pointer for the Interrupt Service Routine called when a debug console character is received.

To use it, declare it with `extern void (*debugConsoleIsr)(char);` and then point it to a function you created, e.g. `debugConsoleIsr =` and your function handleDebugConsoleInterrupt() will be called when a byte is received on the debug serial port.

This is a function pointer for the Interrupt Service Routine called when a debug console character is received. To use it, declare it with `extern void (*debugConsoleIsr)(char);` and then point it to a function you created, e.g. `debugConsoleIsr =` and your function handleDebugConsoleInterrupt() will be called when a byte is received on the debug serial port.

    This is a function pointer for the Interrupt Service Routine called when a debug console character is received.

To use it, declare it with `extern void (*debugConsoleIsr)(char);` and then point it to a function you created, e.g. `debugConsoleIsr =` and your function handleDebugConsoleInterrupt() will be called when a byte is received.

    This is a function pointer for the Interrupt Service Routine called when a debug console character is received.

To use it, declare it with `extern void (*debugConsoleIsr)(int8_t);` and then point it to a function you created, e.g. `debugConsoleIsr =` and your function handleDebugConsoleInterrupt() will be called when a byte is received on the debug serial port.

uint8_t zmBuf[ZIGBEE_MODULE_BUFFER_SIZE]

    This buffer will hold the transmitted messages and received SRSP Payload after sendMessage() was

called. If fragmentation support is not required then this can be smaller, e.g. 100B.