Contrail TDMA Manager User s Reference

Transcription

1 Contrail TDMA Manager User s Reference VERSION 6 Published: May 2018 =AT Maintenance Report Understanding Contrail TDMA Terminology i

2 Contents Chapter 1: Understanding Contrail TDMA Terminology... 3 General Terms... 3 Frequency Capacity Frequency Capacity Slot... 4 Slot Capacity... 5 Chapter 2: Contrail TDMA Manager Concepts... 6 Chapter 3: Login to the TDMA Manager... 7 Chapter 4: Setting Up a Network... 8 Chapter 5: Defining Frequencies and their TDMA Attributes... 9 Chapter 6: Adding Stations (Transmitter, Receiver, Transceiver) Add a Station Assign Stations to Slots on a Frequency Route Management and Pass Lists Chapter 7: QA/QC of Network Design Chapter 8: Import and Export of Design Network Export Network Import Chapter 9: Technical Support ii

3 Chapter 1: Understanding Contrail TDMA Terminology General Terms Term Description ALOHA TDMA Frequency ALERT Frequency ALERT2 Frequency Network Receiver Transmitter Transceiver Frame Length Block Length Slot Length ALOHA is a frequency use protocol in which transmitters transmit at any time when they have something to say and can potentially collide with other transmissions and lose data. The probability of success of ALOHA transmissions can be calculated, assuming that all transmissions are random. ALERT uses the ALOHA transmission protocol. ALERT2 can use the ALOHA transmission protocol, but preferably uses the TDMA protocol to reduce or eliminate data loss. Time Division Multiple Access (TDMA) is a frequency use protocol in which each transmitter is assigned specific times to transmit so that two transmitters on the same frequency do not transmit at the same time and eliminates data loss due to more than one transmitter on a frequency talking at the same time. ALERT2 supports both the ALOHA and TDMA transmission protocols, but preferably uses the TDMA protocol to reduce or eliminate data loss. A specific radio frequency (RF) is a resource used by ALERT and ALERT2 for both transmission and receive of signal. Frequency is usually defined in terms of MHz and is divided into MHz ranges. An ALERT frequency is shared by many transmitters which transmit ALOHA messages and have potential for collisions and data loss. An ALERT2 frequency used for TDMA is defined by a frame length, block length, and slot lengths, that is divided into TDMA slots, which are then allocated to transmitters on the frequency. A network is a combination of frequencies, receivers, transmitters, transceivers used for ALERT and/or ALERT2. A network serves one or more agencies. Base Station, receives on one or more radio frequencies. Transmits on a single radio frequency. Is comprised of both a receiver and a transmitter. A transceiver receives on one or more radio frequencies and transmits on a single radio frequency. They typically are repeaters that listen to data content on their receiver, and then retransmit that content on their transmitter. Frame Length is used to define the transmission repeat for transmitters on a frequency. For example, a transmitter on a 20 second frame would have an assigned TDMA slot with a predefined offset from the top of the frame and be able to transmit every 20 seconds. The block size is the minimum time interval possible for an ALERT2 transmission. In the ALERT2 specification, it is 250 milliseconds (ms), and is the smallest time that can be used for subdividing a frequency's frame into individual TDMA offsets and slots. It is the allocated division of time for a transmitter within a TDMA plan for a frequency. This is one or more whole units of block length. The TDMA plans we currently have use 500 milliseconds as the standard slot length, which with ALERT2 allows up to 75 bytes of information to be transmitted. OneRain Understanding Contrail TDMA Terminology 3

4 Frequency Capacity 1 Term Description Frame Capacity Slots Used Used Slot Capacity Used Slot Load Slot Load Slot Free Space Frame Load Frame Free Space Number of ALERT2 bytes that can be transmitted over the time period of a single frame on a frequency. ALERT2 transmissions are limited to 5 seconds, so capacity is the number of 5 second periods available with a capacity of 977 bytes each, plus the amount of bytes that can be transmitted in the remainder of time. Frame Capacity = INT(FrameLength/5)*977 for all Frame Lengths that are multiples of 5 that are multiples of 5. Number of assigned slots on a frequency, includes the milliseconds of assigned slots. Sum of the number of Bytes that can be transmitted on all of the assigned slots. Sum of the number of Bytes that are expected to be used by each assigned slot. Amount of time used by assigned slots divided by frame length, represented in percent Amount of time that is unassigned, divided by the frame length, represented in percent. (Not sure what Bytes are represented, since it was zero for a completely unassigned frequency). Bytes assigned over frame capacity, as a percent load. Bytes capacity of free space over the frame capacity, as a percent free. Frequency Capacity 2 Term Description Slots Used Slot Usage Efficiency Frame Load Same as above, with addition of a status bar. Same as Slot Load above, with a status bar. Same as above, with a status bar. Slot Term Slots Offset Slot Length Message Type Bytes Capacity Frame Offset = 0/ Frame Length Description Time that slot begins as an offset from the beginning of the frame. Duration of the slot to allow for data transmission. Calculated. Number of bytes to be transmitted during the slot. Number of potential bytes that can be transmitted during the slot length. Frames used to be able to be offset from 0:00:00 UTC, but now always have an offset of 0/ (zero). The repeat interval for the frame. 4 Understanding Contrail TDMA Terminology OneRain

5 Slot Capacity Term Cycles Incoming Slots Incoming Slot Load Calculated Load vs. Defined Capacity Free Space Routes Received Description Transmission cycles for every receive cycle. Receive transmission frame length divided into the transmit frame length. This supports calculating capacity for each transmission. For each cycle, calculation of number of incoming slots and corresponding bytes to be transmitted. Number of slots on input channel and corresponding total time. Bytes carried by the sum of incoming slots. Ratio of incoming bytes over capacity of outgoing slot. Available bytes for the slots transmission. Defined capacity of outgoing slot minus the calculated load. This number gives the remaining capacity of the transmitters slot in the transmitter or transceiver. List of potential routes from this transmitter to other potential receivers and transceivers ordered by closest to furthest and unblocked to blocked. This information will be used to support capacity planning and latency calculations. Blocked routes are routes that are blocked either because there isn't true radio path because of some obstruction or because they are pass blocked at the receive point. List of sites that can be received by this receiver, on the same frequency. OneRain Understanding Contrail TDMA Terminology 5

6 Chapter 2: Contrail TDMA Manager Concepts Contrail TDMA Manager enables realistic ALERT2 network design in visual form. It provides multi-user shared access via web interface and enables information sharing that reduces potential for conflicts or mistakes. Multiple agencies can share access. Contrail TDMA Manager features Capacity Planning and QA/QC Verification ensuring the optimization of transmission capacity across all parts of the network. Contrail TDMA Manager provides a controlled workspace so that users for an agency can edit/maintain agency TDMA designs, and can see, but cannot edit other agency TDMA designs. User accounts are associated with an agency Users can see all other agency networks in Contrail TDMA Manager Authorized users can only edit their own agency s TDMA networks An Agency can manage/design multiple TDMA networks An agency can maintain one or more network designs enabling real-time tracking of live network and allowing for what if alternative network designs 6 Contrail TDMA Manager Concepts OneRain

7 Chapter 3: Login to the TDMA Manager The Contrail TDMA Manager requires a valid login to edit information. To login: 1. Select Login from the dropdown menu on the upper right of the application. 2. You are prompted for a Username and Password. Your Username and Password are assigned to you by your Contrail TDMA Manager administrator. 3. After logging in successfully, a Success message appears. You can verify that you are logged in by choosing the dropdown in the upper right. You should see your Username and a Logout option. OneRain Login to the TDMA Manager 7

8 Chapter 4: Setting Up a Network The following steps will guide you through setting up a new network. 1. Select Agencies in the top menu of the TDMA Manager Home screen. In the Agencies list, select your agency. Your agency information displays with a list of users, and a network list. Note If your login is associated with the agency that you selected, then you have privileges for setting up a new network. Use the + button next to the network list. 2. Select + next to the network list. You are presented with the new network definition screen. 3. Enter the information for this network. If you have formatted network information you can import the information using the Import button. a. Paste tab- or comma-delimited network information in the text field, without headers. b. Imported information must contain Name, Description, and Network Type. Note and Units (US Standard or Metric) are optional. c. Select Save. 4. If you choose to enter the information instead of importing, the following fields are available: 5. Select Save. a. Network Type Simple, Repeater, Hybrid i. Simple is a gauge-only ALERT2 network with no repeaters, i.e., Transmitter (Gauges) send directly to Receiver (Base Stations) ii. Repeater is an ALERT2 network with repeaters, i.e., Transmitter (Gauges) can utilize Transceiver (Repeaters) to send data to Receiver (Base Stations) iii. Hybrid is a mixed ALERT and ALERT2 network, i.e., Transmitter (Gauges) send directly to Receiver (Base Stations) OR Transmitter (Gauges) can utilize Transceiver (Repeaters) to send data to Receiver (Base Stations) b. Name The name for this network that will show up in the Networks list c. Description A descriptive name for this network d. Units US Standard or Metric for displaying distance and elevations when working with this network e. Notes Comments to help give more information on this network 8 Setting Up a Network OneRain

9 Chapter 5: Defining Frequencies and their TDMA Attributes The next step in creating your network is to add frequencies. 1. Select Networks in the top menu on the Home screen. In the Networks list, select the network where you want to add the frequency definitions. NOTE If the network is one of your agency s networks, then you will have the option to add or edit frequencies. Use the + button next to the frequency list. 2. The network screen has a list of frequencies defined. Select + to the right of the frequency list to define a new frequency. 3. Enter the information for your frequency. If you have the formatted frequency information, you can import the frequency using the Import button. a. Paste tab- or comma-delimited network information in the text field, without headers. b. Imported information must contain Name, Description, and Frequency. Unit, Note, Frame Length, Slot Length, Frame Offset, and Block Length are optional. c. Select Save. 4. If you choose to enter the information for the frequency instead of importing, the following fields are available a. Frequency Define the frequency information i. Name Recognizable name for the frequency. For example Gauge Frequency or Repeater Backbone. ii. iii. iv. Description Description of the frequency Frequency RF Frequency Units Hz, MHz, GHz v. Notes Any notes you want to keep on the frequency b. Frame Define the frame attributes of the ALERT2 frequency i. Offset Offset of frame from 0:00:00 UTC. This should always be 0 ii. iii. Length Length of frame in seconds Capacity You can ignore this for now c. Slot Default slot assignments for stations assigned to this frequency i. Block minimum unit size in milliseconds for a transmission (250 ms for ALERT2) ii. 5. Select Save. Default Length Default length in milliseconds for a station to transmit OneRain Defining Frequencies and their TDMA Attributes 9

10 Chapter 6: Adding Stations (Transmitter, Receiver, Transceiver) The next step is to add stations to your network. Add a Station 1. Select Networks in the top menu on the Home screen. In the Networks list, select the network where you want to add the station. NOTE If the network is one of your agency s networks, then you will have the option to add or edit stations. Use the + button next to the station list. 2. Select the + button from above the station list. The new station allows you to define a new station. You also have the option to import stations using the Import button and a formatted list of stations. a. Paste tab- or comma-delimited network information in the text field, without headers. b. Imported information must contain Name, Description, Station Type, and Protocol. Source Address, Latitude, Longitude, Note, Elevation, Elevation Unit, Antenna Height, and Antenna Height Unit are optional. c. Select Save. 3. If you choose to enter the station, the following fields are available: 4. Select Save. a. Type Transmitter, Receiver, or Transceiver i. A Transmitter produces radio waves with the aid of an antenna, transmitting on one or more frequencies. Transmitters are usually gauging stations. ii. A Receiver receives radio waves on one or more frequencies and converts the information carried by them to a usable form. Receivers are usually base stations. iii. A Transceiver combines both a transmitter and a receiver and can both receive and transmit on the same or different frequencies. Transceivers are usually repeaters. b. Protocol ALERT2, ALERT or other c. Name Name of your station. This is visible in the station list d. Description A longer description of your station e. Address Either ALERT or ALERT2 Source Address f. Latitude Decimal Degrees Latitude DD.DDDDD (positive above the equator, negative below the equator) g. Longitude Decimal Degrees Longitude DDD.DDDDD (positive east of the Meridian, negative west of the Meridian) h. Elevation Station Elevation i. Antenna Height Antenna Height above the station (used for path analysis) j. Note Any additional notes on the station 10 Adding Stations (Transmitter, Receiver, Transceiver) OneRain

11 Assign Stations to Slots on a Frequency Add the Station to a Frequency The next step in creating your network is to add the station to a frequency. 1. Select Networks in the top menu on the Home screen. In the Networks list, select the network where you want to link the station. In the Station list, select the station you want to link to a frequency and slot. The Link button on the upper right of frequency allows you to add the station to a frequency. 2. Select the (chain link) Link button and then from the frequencies available, select a frequency for the station to either receive or transmit, or both. You also have the option to import station/frequency links using the Import button and a formatted list of stations and frequencies. 3. After selecting the frequencies, select Save. The Station will now be associated ( linked ) with the frequencies. Assign a Timeslot The final step for each transmission frequency is to assign a timeslot on the frequency to transmit. 1. Select Networks in the top menu on the Home screen. In the Networks list, select the network where you want to link the station. In the Station list, select the station you want to select a time-slot for data transmission. The station shows the message Error Station Slot Not Configured in the slot section if it transmits and does not have a slot assigned. 2. Select the + button to assign a slot. It displays a list of transmission frequencies for that site that might be suitable for slot transmission. In the frequencies list Assign Slot to Frequency, choose the frequency for data transmission to open the slot assignment interface. 3. The slot assignment interface provides a graphical depiction of the frequency, which slots are already assigned, and an interface for assigning the station to a slot on that frequency. The interface allows for editing the timing, duration and station frame (report interval). a. Slot b. Frame i. Offset Offset within the frequency s frame for data transmission ii. Length duration in milliseconds, which equates to byte capacity of the transmission. iii. Note notes on the slot assignment i. Offset Offset should be 0 ii. Length - Transmission frame for the gauge. It must be evenly dividable into the frequencies frame length. Defines how many times the station reports for every frequency frame. 4. After setting the slot information, select Save. Route Management and Pass Lists 1. Select Networks in the top menu on the Home screen. In the Networks list, select the network where you want to manage the station route. In the Station list, select the pertinent station. The list of potential routes from this station to other potential receivers and transmitters is ordered by nearest to furthest and unblocked to blocked. OneRain Adding Stations (Transmitter, Receiver, Transceiver) 11

12 2. To modify the list of routes, select Edit in the Routes panel. Reorder the routes can by dragging and dropping in the desired order. 3. Routes can also be imported using the Import button and a formatted list of stations and frequencies. Pass Lists Pass Lists for a specified route for receivers can be imported using the Import button and a formatted list. 1. For HydroLynx, formatting should look like: 0=2,4020,4055,0 1=2,4070,4075,0 2=2,4100,4115,0 3=2,4160,4165,0 2. For Simple (Comma Range), formatting should look like: 3. Select Save 4020, , , ,4165 NOTE After a Pass List import, all other routes will be blocked. 12 Adding Stations (Transmitter, Receiver, Transceiver) OneRain

13 Chapter 7: QA/QC of Network Design The Contrail TDMA Manager provides many tools for QA /QC (quality assurance/quality control) of your TDMA network design. A summary of the network analysis that is done automatically include: 1. Verification that a station can transmit its data payload in the slot time allocated for data transmission. 2. Verification that the bytes of data heard by a transceiver (repeater) can be transmitted in the available transmission slot. 3. Path analysis tools for verifying that a station that transmits on a frequency has radio path to all possible receivers on that frequency within that network. This tool also prioritized initially based on distance, and the automatic priority can be manually overridden by user input. 4. Verify that a station is assigned to frequency 5. Verify that a station with transmitter capability has an appropriate slot assignment on the output frequency 6. Visual tools for looking at frequency slot assignment. 7. Visual tools for looking at latency of station that travel through multiple frequencies OneRain QA/QC of Network Design 13

14 Chapter 8: Import and Export of Design The ALERT2 TDMDA manager allows full capability for exporting a network design. The export capability is available for all users, even read-only users. Network Export Network export is available by selecting the network you are interested, and the selecting the Export button on the upper right (button is a down arrow above an open box). This downloads the complete specification of the network to a comma delimited CSV file. This is one way to archive or backup your network designs outside of the Contrail TDMA Manager. Network Import Network import can be done in steps to copy a network design and re-importing into a new network design. Network import must be done in steps. 1. Importing your network definition Choose your agency, and then select the + above the networks for that agency. For the network data entry screen, it has an import option at the top right that allows you to import the Network section of the network export above. Note that the imported network must have a unique network name from all of the existing networks. Once a unique network is defined, all of the subsequent frequencies, station only have to be unique within the network. 2. Import the frequencies The frequency input screen, described in Chapter Chapter 5:, has an import button that allows for the import of frequencies. 3. Import the station definitions The station input screen, described in Chapter Chapter 6:, has an import button that allows for bulk import of station definitions. 4. Import the links Links are the frequency assignments per station. The import is described in Chapter 6. This uses a section of the network export definition that allows for bulk import of frequency assignments per station. 5. Import the Slot information Slot assignment import is described in Chapter 6. For a power user, exporting a network definition, editing it manually in a tool like Microsoft Excel, and then importing that modified design is one of the fastest ways to make changes on a network quickly and efficiently. Examples of network changes that can be done efficiently by exporting and then importing a modified network design include: 1. Bulk assigning source addresses based on fields in the Contrail TDMA Manager, like alphabetically by site name, or numerically by ALERT ID, or geographically by latitude or longitude. 2. Bulk assignment of slots on a frequency by some orderly scheme, such as alphabetically or by Source Address. 3. Mass frequency reassignment. 4. Creating import datasets from legacy base station reports. 5. Many other methods. 14 Import and Export of Design OneRain

15 Chapter 9: Technical Support How to Get In Touch with our Support Team The best way to get in touch with us and quickest way to get answers to your questions is by ing our support team: Contrail Software Support General Technical Support OneRain Incorporated 1531 Skyway Drive, Unit D Longmont, Colorado USA Visit our website at U.S. Toll Free: RAIN (7246) or from anywhere: (USA MT 8:00 a.m. to 5:00 p.m., Mon.-Fri.) OneRain Technical Support 15