Summary of Contents for Neo.cortec NCxxxx series
- Page 1 Integration Manual for NCxxxx series Modules Doc Status: Release Doc version: Date: Dec 2015...
-
Page 2: Table Of Contents
Table of Contents 1 Document revisions ......................3 2 Introduction ........................3 3 Abbreviations ........................3 4 Definitions ........................3 5 System Considerations ....................4 5.1 Power Supply ........................4 5.1.1 Voltage capabilities ....................4 5.1.2 I/O Voltage levels ....................4 5.1.3 Current sourcing capabilities ................. -
Page 3: Document Revisions
Fixed error in WES doc. 2 Introduction This document describes how to integrate the NEOCORTEC NCxxxx series modules with a Host Controller both from a SW and HW perspective. The Host Controller can be an embedded micro controller or a PC. -
Page 4: System Considerations
5 System Considerations When designing a product that contains the NCxxxx module, there are a few items from a System point of view that need to be considered. This section of the document lists these items, and where applicable provides recommendations on solutions. -
Page 5: Sleep
5.2 Sleep As the external controller, as well as the NEOCORTEC Module, is expected to spend a lot of time in sleep mode to save power, it is important that wake-up is synchronized, so that the modules can communicate with each other. -
Page 6: Serial Uart Interface
7 Serial UART Interface The NEOCORTEC NCxxxx module provides two serial communications ports, which are, used for each their own individual purpose: Name Desciption Application API Used to interface the Host Controller Application layer with the NC2400 Module. Provides functions for sending... -
Page 7: Easy Integration With Pc
Figure 1 - Generic UART Interface drawing nWU is used as a wake-up signal, to indicate that the NEOCORTEC module is waking up, and that it may have data to send. The external controller must not ignore this wake- up, and must start the UART receiver at latest at the time specified by WU setup time, after wake-up. -
Page 8: Communication Specification - Application Uart
1,6,9,15, 26 Note: nWU is not connected, as it is assumed the PC will not be entering sleep mode, and will always be ready to send and receive data. 8 Communication Specification – Application UART 8.1 Logical data exchange Data is exchanged over the interface in Big Endian byte order. -
Page 9: List Of Commands
8.2.1 List of commands Command Code Length Data Return Description 0x02 NEOCORTEC Write data to device / port. API_CMD_TX_UN ID + 1 byte Maximum payload size is 19 byte ACKNOWLEDGED port + payload Refer to text below table for more details. - Page 10 Once the packet has been enqueued in the NEOCORTEC module, there will be no messaging back to the application layer indicating if the transmission to the destination was successful. Send Acknowledged Packet: Similar to the above mentioned command, this command initiates the transmission of application payload data to another NEOCORTEC module inside the NEOCORTEC network.
-
Page 11: List Of Application Data
List of application data Code Length Data Description 0x50 ID(2) Acknowledge for previously sent packet 0x51 ID(2) Non-Acknowledge for previously sent packet 0x52 Header + Payload Data received from another device (see below) 0x53 Header + Payload Data received from another device... -
Page 12: Api For Embedded Controllers
See the USER GUIDE for more information about how to enable HAPA. 8.3 API for embedded controllers A C90 compliant API is provided which simplifies the integration of the NCxxxx series modules, with an embedded controller. When using the API, the user does not need to worry about how to generate UART frames, nor how to decode them. - Page 13 Figure 2 - NcApi structure The API serves as layer, which implements high-level functions for sending and receiving payload data through the mesh network. The API provides two basic functions to the application layer: NcApiInit & NcApiSendAcknowledged. NcApiInit will have to be called once to initialize the API.
- Page 14 The application layer can register for HostDataCallback. The callback is issued when the modules receives payload data from another module in the NEOCORTEC mesh network. The callback function delivers a pointer to a struct containing the following information: OriginatorID, Port number, PayloadLength, Packet Age & Payload.
-
Page 15: Communication Specification - System Uart
Further details of the data structures as well as the functions, can be found in the Documentation folder, which is part of the API delivery. Open the “index.html” file in your preferred browser. 9 Communication Specification – System UART The System UART serves three purposes;... -
Page 16: Examples
10 Examples 10.1 Acknowledged Payload data transmission through the network In the following example, payload data is send from a sensor node to a PC which is attached to another node in the NEOCORTEC network. Figure 3 - Network example In the example, the Originator node has the NEOCORTEC ID 0x00 20 and the Receiving node has the NEOCORTEC ID 0x00 2A. -
Page 17: Wireless Encrypted Setup
2) The payload data arrives at the Receiving node and is delivered to the PC via the UART interface: Section Code Length UART Payload Content 0x52 0x06 0x002000500023 At the same time, an acknowledge message is send from the Receiving node back to... - Page 18 2) The WES Announcing Node is now put into WES server mode by issuing the following command from the uController (or Host in general) to the node: Section Code Length UART Payload Content 0x10 0x01 0x01 3) When the unconfigured node discovers the announced network, it will send a setup request to the announcing node.