Quick Start Guide. TWR-METRO-KIT Development Kit. Featuring Nivis Smart Objects Solution TOWER SYSTEM

Transcription

1 Quick Start Guide TWR-METRO-KIT Development Kit Featuring Nivis Smart Objects Solution TOWER SYSTEM

2 Quick Start Guide Getting to Know the Metropolitan Area Network Development Kit TWR-METRO Smart radio module Antenna TWR-TWRPI-BD TWR-P1025 TWR-ELEV 2 TWR-METRO-KIT Freescale Tower System The TWR-METRO-KIT is designed to work either in standalone mode or as part of the Freescale Tower System, a modular development platform that enables rapid prototyping and tool re-use through reconfigurable hardware. Take your design to the next level and begin constructing your Tower System today by visiting freescale.com/tower for additional Tower System MCU modules and compatible peripherals.

3 TOWER SYSTEM Metropolitan Area Network Development Kit Features The Metropolitan Area Network development kit (TWR-METRO-KIT) is a user-friendly and versatile development kit that serves two purposes: 1. The main purpose of the kit is to allow interested parties to swiftly integrate Nivis secondgeneration wireless smart object technology into their products. The Smart Object Networking platform is running on a Freescale-based state-of-the-art sub-gigahertz hardware platform. The user can access the smart object stack over an UART or SPI serial communication port, allowing the user to connect an application processor to the stack modem. With minimal firmware development effort and following a simple API, the user can swiftly build a wireless product that is an integral part of the Internet of Things. 2. The secondary purpose is to allow users to evaluate the performance of: The Freescale-based smart object hardware platform Nivis second-generation wireless Smart Object Networking platform The Nivis Smart Object Networking platform is a wireless communication platform based on IEEE and IETF standards for low-power, short-range, resource-constrained wireless devices. It enables building wireless smart objects through which the Internet is extended to small, embedded objects that monitor and control various parameters in our surroundings. The communication platform was architected and developed with these key design goals: High scalability Standards compliance: All facets of the communication platform are compliant to the latest IEEE and IETF standards that target low-power, short wireless range smart objects IEEE g/e-based wireless communications and media access control 6loWPAN/IPV6 connectivity High reliability of data delivery is ensured through path diversity based on the IETF ROLL defined RPL routing protocol Support for REST/COAP-based web services Allowing the user to map application parameters into COAP modeled resources that are encoded utilizing EXI/XML Class-leading link layer security and authenticity Support for both line- and battery-operated devices 3

4 Quick Start Guide Smart Object Development Kit Topology Smart Object Kinetis Processor Navajo MC12311 Ethernet Network and Application Monitoring Tool Lite Scalability: Up to 10 Smart Objects Standard Kit: 2 Smart Objects Application Specific Module Smart Home Transportation Environment Smart Building Not part of the standard kit. Edger Router Line Powered Smart Object Battery Operated Smart Object 4

5 TOWER SYSTEM Fig. A 5

6 Quick Start Guide Step-by-Step Installation Instructions 1 Getting Started A PC running Windows is necessary to install and run the Network and Application and Monitoring Tool (NAMT). A router providing Internet access to both PC and the edge router is highly recommended. Recommended IPv4 of the router is (as the edge router gets configured by default to use as default gateway for Internet access). If the router has a different IPv4 address, some additional configuration will be necessary on the edge router (see section Setting up the Edge Router for details). Freescale TWR-TWRPI-BD module (4) TWRPI adapter module (5) NIVIS SMO radio module (6) Bulk-head antenna cable (7) Antenna (8) AC-DC power adapter for TWR-P1025 (9) Ethernet cable (10) Assembling the Edge Router Start with the Freescale TWR-P1025 module (1) Internet connectivity for the PC on which the NAMT is installed and for the edge router is highly recommended to sync the WLAN network time with NTP time servers that reside on the Internet. Steps to a functional kit: Connect the kit components Power up the kit components Configure the kit Install the NAMT Connect the NAMT to the edge router Attach the TWR-ELEV module. White sockets are on the left (2) as shown in Fig. A, so the P1025 accommodates the lower slot and the power connector is on the left side close to the white elevator module. 2 Connecting the Kit Components Edge Router The kit includes the following hardware components for assembling an edge router (refer to Figure A.): Freescale TWR-P1025 module (1) Freescale TWR-ELEV module: white left (2), black right (3) 6

7 TOWER SYSTEM Attach the Freescale TWR-TWRPI-BD module (4) on the top slot. The antenna hole is on the far side. Install the bulkhead antenna cable (7) into the TWR-TWRPI-BD module antenna hole and attach the MMCX end to the NIVIS SMO radio module (6) antenna connector as shown. Attach the second TWR-ELEV module. Black (3) on the right side. Press both elevators so cards fit into the sockets. Verify the TWR-TWRPI-BD module (4) jumpers. All jumpers should be removed except the two (11) that route the TXD and RXD lines. Assemble the TWRPI adapter module (5) together with a NIVIS SMO radio module (6) using screws, spacers and other mechanical elements provided. Insert the assembly into slot B of TWR- TWRPI-BD as shown in Fig. A. The edge router is now assembled. 7

8 Quick Start Guide Fig. AB Smart Object Device The kit includes the following hardware components for the smart objects device: 2 x METRO-NODE (one line-powered smart object, one battery-powered smart object) 1 x AC/DC power supply (mini-usb connector) 1 x battery set (3 x AA primary cell battery) Verify that the antenna cable (2) is attached to the SMO radio module s (2) MMCX antenna port Verify that the jumper bank (18) has all jumpers installed (J14, J15, J8, J16, J21, J7, J10 all ON) Verify that the LED s jumpers (19) are both installed (J19, J20 both ON) Verify that the power-on jumper (14) is removed from connecting pins (J18 is OFF) Verify that switch SW4 s (10) lever is set toward the UART marking of the PC board Verify that toggle switch SW2 (19) is set to the middle position 8

9 TOWER SYSTEM 3 Powering up the Kit Components Powering up the Edge Router Attach one end of an Ethernet cable (10) to the Ethernet port located on the top. Insert the other end of an Ethernet cable to network equipment (Ethernet switch or hub). Optional: An external Ethernet router is not absolutely necessary (but highly recommended). Instead of connecting to the external router, the Ethernet cable (crossover) can be connected directly to the PC; in this case the TER will start with incorrect time, and the edge router startup sequence will be delayed several minutes (trying to get time from Internet time servers). In this case, the NAMT running on the PC will set the edge router time on first connect (the user must accept the edge router time correction, otherwise the kit will malfunction). Until the time is properly set on the edge router (either from Internet time servers or from NAMT), the network will not join. Attach the AC-DC power adapter (9) barrel to the power connector of the edge router. This is located on the left side. Connect the power adapter to the AC socket or cord and confirm that the LED on P1025 lights up. After a few seconds, observe the LEDs installed on the Ethernet port. One LED will be in a solid ON state which indicates a link to the Ethernet network. The second LED will blink indicating network activity. Proceed to the section, Getting Started with the NAMT for software setup/ configuration of the edge router. Setting up the Edge Router Care should be taken to ensure that communication with the edge router or NAMT does not attempt to use the wireless adaptor. Suggest disabling the wireless adaptor if present. Before proceeding with this step, ask the IT department for the IPv4 of a valid name server in your organization network. Note: there are name servers publicly available for free on the Internet, suggest using those if the name server in your organization is not available. Note: Recommend using a name server valid for your organization. There are name servers publicly available for free on the Internet; we suggest using those if the name server in your organization is not available. By default the edge router arrives preconfigured with a working name server freely available on the Internet. With its default settings, the edge router does not need any configuration in order to form the network and to accept connections from NAMT, assuming the NAMT PC resides in the same network segment with the edge router ( x), and the edge router is connected to the Internet through a gateway with IP Default edge router IP address is Recommend using as NAMT PC static IPv4 address; use the section below to set it up. Configuring the PC Static IP Address to Enable Access to the Edge Router The PC running NAMT must be configured with an IP in the subnet x (recommended , but any other IPv4 except / will do), net mask , and default gateway Recommended: Ask your IT department to configure the IPv4 of the PC running NAMT. 9

10 Quick Start Guide Alternate: Set the PC yourself. Step-by-step instructions for Windows 7: Open Control Panel > Network and Sharing Center Click Properties Click Local Area Connection Click Internet Protocol Version 4 (TCP IPv4), then click Properties Enter IPv4: , Subnet Mask: , Default Gateway Check Validate settings on exit Click OK 10

11 TOWER SYSTEM Changing the ER IP Address If the NAMT PC IP cannot be modified for x network segment, the user can modify the edge router IP instead. Note: Do not attempt to set the NTP servers in the network configuration page. The setting generates no effects. Should the default settings/configuration (edge router IPv4: , NAMT PC IPv4: , gateway IPv4: ) be used, skip the rest of this section. Use /admin/ interface to configure the ER IP and assign it an IP in the user LAN. To do so, point a browser to admin/, enter username: admin and password: adminadmin, click on network configuration, change IPv4 settings, click Save, then reboot the board. Note: If the edge router does not have the time properly set (as it may be immediately after being assembled), the /admin/ web interface will not work (cookies expire instantly, resulting in an inability to log in) when accessed from Internet Explorer. Please use Chrome or Firefox if this is the case. Note: The following settings are mandatory: IPv4, mask, gateway and name server. Recommended: use the name server IPv4 specific to your organization (ask IT support for it), not necessarily the one in the screen shot. Alternately, you can use the IPv4 of one of the freely available name servers on the Internet. Note: For smart objects to join an edge router, the vendor ID on the edge router must match the Net ID in the smart object. By using the defaults, the smart objects and the edge router settings are matched. However, in the case of two networks coexisting in the same area, the user must change both settings (Vendor ID, Net ID) on at least one of the networks. To change the VendorID, log in to the Edge Router and edit the file /jffs/nivis/far/activity_ files/far_comm_profile.txt In section [Network] change the value of variable VendorNetworkID, save and power cycle the edge router. See SMO_Kit_Configuration.docx on instructions for how to change the Net ID on the smart objects. 11

12 Quick Start Guide Powering up the Smart Objects Please note that any smart object can be either line powered or battery operated. Note: The communication stack will dynamically adapt to the power source and report it to the NAMT as either line power or show the status of the battery (if battery operated). Please also note that batterypowered smart objects operate differently than line-powered smart objects to conserve battery power. Power the battery-operated smart object(s) by inserting the AA batteries into battery holder BH1 located on the bottom side of the power pack. Install batteries with respect to the polarity marked inside the holder. Power line-powered smart objects devices by connecting the AC/DC power supply mini-usb connector to the mating mini-usb socket located on the power pack board (3). Connect the AC/DC power supply to the AC power line. Note: Do not install batteries on linepowered smart objects. Install power-on jumper (14) (J18 installed, is ON). Observe the green-colored JOIN STATUS LED (6); it should start blinking. This LED will blink for approximately 10 seconds then turn off to conserve power. To check the status, the operator must push the momentary STATUS button (5); the LED will light up to indicate the JOIN STATUS of the smart object. A blinking LED indicates that the smart object has not yet joined the network. Re-check the JOIN STATUS by pressing the STATUS button (5) and observing the LED behavior until the green LED remains in a solid ON state. This indicates that the status of the smart object is now joined to the network. At this point, the smart object is joined and the analog and digital inputs can be modified at will while observing the response of these actions in the NAMT (after connecting the NAMT to the edge router, see section Getting Started with NAMT ). Exercise analog input: Operator rotates R21 ANALOG potentiometer (8 in figure AB) and observes variations. By rotating the potentiometer knob clockwise, the output value will increase. Rotating counter clockwise will decrease the output value. See also section Hello Smart Object World in this document. Exercise digital input: Operator toggles SW2 (7 in figure AB) lever toward SW4 to exercise the ON state for the digital input. Toggle SW2 lever back to the middle or toward the J20 jumpers to exercise the OFF state for the digital input. See also section Hello Smart Object World in this document. At this point, the user can also communicate with the smart object communication stack via the serial ports provided on the power pack utilizing the simple API. Note: For smart objects to join an edge router, the vendor ID on the edge router must match the Net ID in the smart object. By using the defaults, the smart object and edge router settings are matched. However, in case of two networks coexisting in the same area, the user must change both settings on at least one of the networks. See SMO_Kit_Configuration.docx on instructions how to change the Net ID on the smart object. 12

13 TOWER SYSTEM 4 Getting Started with the NAMT The NAMT is a Windows-based monitoring and management tool supplied by Nivis that allows the end user to evaluate the performance of the smart object network. Step-by-Step Installation Procedure The NAMT is provided along with a standard application installer that allows for a simple installation procedure. The installer can be launched by executing setup.exe in the install package. In the introduction screen, click Next to start the install procedure. The installer will automatically suggest C:\Program Files\Nivis\Smart Objects Integration Kit\ as the install folder: During the setup, a folder named Nivis will be created under the Windows Start menu. The NAMT can be launched or uninstalled by running the corresponding applications in this folder. Brief Overview of the NAMT Connecting to an Edge Router To connect the NAMT to the edge router, the PC hosting the NAMT must be connected in the same network segment (or subnet) as the edge router. If the edge router is operating using the default network setting, it is recommended that the PC hosting the NAMT use the IPv4 address. See section Setting Up the Edge Router for matching the edge router IP network settings with the network settings of the PC hosting the NAMT. If the PC hosting the NAMT and the edge router has IP addresses that are in the same network or subnet, the NAMT will connect to the edge router when started. User can change the path by entering or selecting the desired installation folder. The user can also specify if the NAMT should be accessible to all users or only to the user installing it. After the corresponding installation options are selected, clicking Next will start the install process. When the setup is complete, clicking Close will finish the installation. At NAMT startup, the NAMT will ask for the information necessary for connecting to the edge router: Edge router IPv4 (by default ) Username (admin) Password (adminadmin) The application setup can be stopped at any time by clicking Cancel. 13

14 Quick Start Guide The user must provide the IP address of the edge router and the authentication credentials or select from a list of saved connections. When the user presses OK, the NAMT will attempt to connect to the target edge router. If the connection succeeds, the network monitoring module of the application will be started. If the user presses Cancel, the connection window will be closed and the main NAMT window will be displayed. The user will be able to connect to an edge router to manage the application settings or to close the application. Note: If the TWR does not have the time set (no Internet connectivity and no NAMT connected since last power on of the TWR), a message box is displayed asking the user permission to correct the time on the TWR. Answering Yes is mandatory at this step, otherwise the system will expose undefined behavior. Please wait for five minutes before re-connecting to the TWR after this operation. Note: If the TWR time was previously set correctly, the TWR time incorrect warning message box does not appear at all. If the time on the edge router was set (either from the Internet, or set trough a previous NAMT connection), then the PC time changed more than one hour, the resulting system would have an inconsistency between the SOs and the TWR, with undefined behavior. To prevent this, if NAMT detects the TWR has the time set, yet TWR time is too different (more than one hour apart) from the NAMT PC time, the NAMT will refuse to connect to the TWR and will recommend restarting TWR and SOs. After the user answers Yes, a message box will confirm the successful operation. The TWR is restarted automatically and the network will re-form. Such a scenario can only occur if the user changes the time on the PC hosting NAMT, or if several PCs running NAMT are used to connect to the same TWR and one of the PCs has incorrect time. If you see the message above, please reboot the edge router and all smart objects. 14

15 TOWER SYSTEM Main NAMT Operations The main application window provides the following functionality: Connect to the edge router Disconnect from the edge router (available only while connected to an ER) Settings (manage application settings) Exit (closes the application) Select module (switch between the network monitoring and development kit modules) The Network Monitoring Module The network monitoring module provides information related to the WLAN composed of wireless smart objects and the edge router. It allows the user to visualize various device- and network-related statistics that are indicative of the performance of the network. When accessing the network monitoring module, a list of joined devices is displayed and the user can toggle between grid, map and a logical view of the network devices. The user can also visualize and modify some of the network settings (security level, channels map and hopping sequence): The details of the network devices are available by clicking on the Device Properties button Device properties. The user can also upgrade the communication stack of the smart objects over-the-air (wirelessly) from the NAMT. The user can initiate firmware update operations by selecting in the grid view the target devices and clicking Firmware Update. See the document Smart Object Development Kit User Guide for additional details. The current view of the network devices list can be printed or exported by clicking the corresponding button. 15

16 Quick Start Guide The Development Kit Module The development kit module consists of two views: a dashboard showing the devices joined to the network that are actively publishing data based on the APP0 resources group and a grid with all resources on all devices, indicating which resources are observables, allowing the configuration of observed resources (only observable resources can actually be observed), and showing the raw values (not parsed, with history) of the resources actually observed. There are two buttons in the top right corner allowing the switch between dashboard view and grid view. The Development Kit Module The development kit module consists of a dashboard showing the devices joined to the network that are actively publishing data based on the APP0 resources group. The following application parameters (modeled as COAP resources) are part of the APP0 resource group: Digital state (the status of the SW2 toggle switch present on the power pack board) Analog state (the status of the R21 potentiometer present on the power pack board) Power supply status (the status of the smart object power supply. The smart object can be line powered or battery powered. If the smart object is battery powered, the remaining battery power will be reported periodically and displayed in the development kit module.) See the document Smart Object Development Kit User Guide for additional details. 16

17 TOWER SYSTEM The Development Kit Module Grid View The grid view in the NAMT development kit pane displays resources, resource values and configuration. The image above highlights various controls: Display a summary of number of devices and resources, total per system Display the total number of resources and observed resources for each device Expand a device for additional controls: Show all resources Show last COAP communication time Highlight last received value (if belongs to device currently expanded) Access to values history Show whether the resource is observable or not For observable resource allow configuring it as observed/not observed Note: The values history gets built by NAMT and it s not stored between successive NAMT sessions. See the document entitled Smart Object Development Kit User Guide for additional details. 17

18 Quick Start Guide Hello Smart World Objects The Tower Metro development kit (TWR-METRO-KIT) allows the user to evaluate the performance of the Nivis Smart Object Networking platform. The smart object end node (SOEN) continuously monitors and reports three application parameters. These three application parameters are mapped into three COAP-modeled web resources. In addition to the traditional HTTP/COAP client-server requests, the COAP standard also defines an observable mechanism. The observable mechanism allows constrained devices to periodically publish resources to a client without the client having to get the resource. The observable mechanism was specifically designed for multi-hop wireless networks in which the traditional HTTP client-server data model based on request-response interactions is very inefficient. The observable mechanism allows for decreased traffic over the wireless channels and results in increased wireless bandwidth and prolonged battery life in multi-hop wireless networks. The observable mechanism allows the smart object to transmit web resources: 1. Periodically (based on a pre-defined period) 2. Change triggered (when the value has changed by a certain differential) The SOEN monitors and periodically reports the parameters modeled as COAP resources listed in the table below. Parameter URI Power Range Reported Pack Board Hardware Reference Digital ON/ OFF Analog stat Battery /app/ sw /app/ ptm /app/ batt SW2 ON - OFF Reported when status changes. Typical latency end-to-end (SOEN to NAMT display) is three seconds. R % Reported when pot value varies by > 5 percent. Typical latency end-to-end (SOEN to NAMT display) is three seconds. NA Line power or battery power left (%) Reported when battery value varies by > 5 percent. Typical latency end-to-end (SOEN to NAMT display) is three seconds. Once the Smart Object Network is up and running, a first evaluation scenario consists of simply observing the change of the three pre-defined application resources. 18

19 TOWER SYSTEM 1. Ensure in the NAMT that the SOEN is joined to the network (its MAC appears in the development kit, status as Joined, yellow font). Example for device with MAC ending with 00:06:00:30 2. Toggle the digital ON/OFF switch (SW2) present on the power pack board every five seconds. Observe the change in value in the NAMT development kit pane. 3. Vary the potentiometer R21 present on the power pack board by turning it by more than 45 degrees. Observe the change in value in the NAMT development kit pane. 19

20 Quick Start Guide Appendix A: FCC Related Statements General Statements (For all devices): Warning: Changes or modifications to this device not expressly approved by Nivis, LLC could void the user s authority to operate the equipment. FCC Specific Statements: For Class B Devices: NOTE: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: Reorient or relocate the receiving antenna. Increase the separation between the equipment and receiver. Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. Consult the dealer or an experienced radio/tv technician for help. RF Exposure This equipment complies with FCC radiation exposure limits set forth for an uncontrolled environment. This equipment should be installed and operated with minimum distance 20 cm between the radiator and your body. This transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. Appendix C: Industry Canada Related Statements Industry Canada Specific Statements: Antenna (General): Under Industry Canada regulations, this radio transmitter may only operate using an antenna of a type and maximum (or lesser) gain approved for the transmitter by Industry Canada. To reduce potential radio interference to other users, the antenna type and its gain should be so chosen that the equivalent isotropically radiated power (EIRP) is not more than that necessary for successful communication. Conformément à la réglementation d IndustrieCanada, le présent émetteur radio peut fonctionner avec une antenne d un type et d un gain maximal (ou inférieur) approuvé pour l émetteur par Industrie Canada. Dans le but de réduire les risques de brouillage radioélectrique à l intention des autres utilisateurs, il faut choisir le type d antenne et son gain de sorte que la puissance isotrope rayonnée équivalente PIRE ne dépasse pas l intensité nécessaire à l établissement d une communication satisfaisante. 20

21 TOWER SYSTEM Detachable Antenna: This radio transmitter (identify the device by certification number, or model number if Category II) has been approved by Industry Canada to operate with the antenna types listed below with the maximum permissible gain and required antenna impedance for each antenna type indicated. Antenna types not included in this list, having a gain greater than the maximum gain indicated for that type, are strictly prohibited for use with this device. Le présent émetteur radio (identifier le dispositifpar son numéro de certification ou son numéro de modèle s il fait partie du matériel de catégoriei) a été approuvé par Industrie Canada pour fonctionner avec les types d antenne énumérés ci-dessous et ayant un gain admissible maximal et l impédance requise pour chaque type d antenne. Les types d antenne non inclus dans cette liste, ou dont le gain est supérieur au gain maximal indiqué, sont strictement interdits pour l exploitation de l émetteur. Approved Antennas: Type Gain ½ Wave Whip 2 dbi Compliance: This device complies with Industry Canada licence-exempt RSS standard(s). Operation is subject to the following two conditions: (1) this device may not cause interference, and (2) this device must accept any interference, including interference that may cause undesired operation of the device. Le présent appareil est conforme aux CNR d Industrie Canada applicables aux appareils radio exempts de licence. L exploitation est autorisée aux deux conditions suivantes : (1) l appareil ne doit pas produire de brouillage, et (2) l utilisateur de l appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d en compromettre le fonctionnement. Label Information Additional Requirements for Modular Approved Devices: When a modular device is used in an end product where the label of the module is not visible, the host device must have an exterior label to include the information shown below. If a label for the host device is not available, the manual must provide information to the integrator on labeling requirements. Contains FCC ID: SQB-NIVISVN400 Contains IC: 6546A-NIVISVN400 21

22 Visit freescale.com/twr-metro-kit for the latest information on the Metropolitan Area Networks kit. Support Visit freescale.com/support for a list of phone numbers within your region. Warranty Visit freescale.com/warranty for complete warranty information. For more information, visit Freescale.com/TWR-METRO-KIT Join the online Tower community at towergeeks.org Freescale and the Freescale logo are trademarks of Freescale Semiconductor, Inc., Reg. U.S. Pat. & Tm. Off. All other product or service names are the property of their respective owners Freescale Semiconductor, Inc. Document Number: MANDEVKITQSG REV 0 Agile Number: REV A