```{eval-rst} .. meta:: :description: A guide to the CloudRF Function Menu and RF tools, covering the Side Menu, templates, input menu and output console. ``` # Web Interface RF Tools ## Function Menu The **Function Menu** is a set of various key functions located on the top of the interface. Each function has a designated clickable button that allows you to locate them easily on the interface, thus making the tool easy-to-use and user-friendly. ## Function Menu Overview ![Cloud RF function menu](Images/InterfaceWeb/RFFunctions.png) ## ![Collapse icon](Images/InterfaceWeb/Icons/Collapse.png) Expand/Collapse Side Menu The **Expand/Collapse** button lets you expand or collapse the Side Menu consisting of Templates, Input Menu and Output Console. To **Collapse** the side menu: - Click on the **Expand/Collapse** ![Collapse icon](Images/InterfaceWeb/Icons/Collapse.png) button. - The *Side Menu* will collapse. > When you mouse-over upon the Side Menu, the expanded view of the menu will appear. To **Expand** the side menu: - Click on the **Expand/Collapse** ![Collapse icon](Images/InterfaceWeb/Icons/Collapse.png) button. - The *Side Menu* will expand. ## Area Tool The default tool, active when none of the function menu tools are enabled, is the area calculation tool. Set the Transmitter location by clicking on the map or by editing the Input Menu. Then, click on **Run** ![Run icon](Images/InterfaceWeb/Icons/Run.png) button to start an area calculation. ![Area Output Example](Images/InterfaceWeb/Area/Output.png) (bounded_calculation)= ### Bounds With the Management Menu's ![Imagery icon](Images/InterfaceWeb/Icons/DrawBounds.png) Draw Bounds functionality, you can draw bounds on the map. The bounds can be removed by clicking on the Draw Bounds icon again. This can be used to speed up calculations, or obtain higher resolution output in the same time, when you are only interested in a portion of the Transmitters coverage. ![Area Bounded Output Example](Images/InterfaceWeb/Area/BoundedOutput.png) ## ![Path profile tool icon](Images/InterfaceWeb/Icons/PathProfileTool.png) Path Profile Tool The Path Profile Analysis tool lets you inspect the terrain profile between two positions - **Transmitter** and **Receiver**. ![Path profile tool screen](Images/InterfaceWeb/PathProfile/Overview.png) ### Point-to-Point Path Profile Analysis (Tx to Rx) For Point-to-point path profile analysis (Tx to Rx), you can set the Transmitter and Receiver location either by *Visual Map Placement* or *Precise Location Entry* method. 1. **Visual Map Placement** You can click on the Map to site your **Transmitter** and **Receiver** location visually: - Site your **Transmitter** location on the map. - Click on the **Path Profile Tool** ![Path profile tool icon](Images/InterfaceWeb/Icons/PathProfileTool.png) button on the Function Menu. - Click on the map to site your **Receiver** location. 2. **Precise Location Entry** To use GPS co-ordinates, you can configure the **Transmitter** and **Receiver** location manually: - Configure your **Transmitter** location (Latitude and Longitude) in the *Site/Tx* Input Menu. - Click on the **Path Profile Tool** ![Path profile tool icon](Images/InterfaceWeb/Icons/PathProfileTool.png) button on the Function Menu. - Configure your **Receiver** location in the *Mobile/Rx* Input Menu. - Click on **Run** ![Run icon](Images/InterfaceWeb/Icons/Run.png) button. **Dynamic chart** After setting your Transmitter and Receiver locations, the **Dynamic chart** will appear. - The **Path Profile** in the form of a dynamic chart consisting of the path profile components - ***Terrain***, ***Fresnel*** and ***LOS*** will be displayed. ![Path Profile Tool Result Screen](Images/InterfaceWeb/PathProfile/DynamicPPAChart.png) - The Transmitter and Receiver related information (*Distance, Frequency, Model, Path Loss, Received Power, Field Strength, Tx Antenna Gain, ERP, EIRP, Rx Antenna Gain*) will also be displayed along with the interactive chart. - You can click on the **PNG** link to download the Path Profile as a static PNG image suitable for insertion into a report. Attribution is included as a watermark behind the key. *Note the static image will appear with different dimensions but the same result as it comes from the same API but uses a different plotting library.* ![Path Profile Tool static image](Images/InterfaceWeb/PathProfile/staticPPAImage.png) - Various **Function Icons** will be available as you mouse-over on the dynamic chart. ![Path Profile Tool Function Icons](Images/InterfaceWeb/PathProfile/Tools.png) - **Zoom** - lets you zoom the desired section of the Path Profile Graph. - Click on the desired section's starting point and without releasing the mouse, select the section. - **Pan** - lets you pan view the graph interactively. - On selecting the *Pan function* icon, the pan mode for axes gets turned on in both `x` and `y` directions. - Click on the graph and without releasing your mouse, move in the direction you wish to pan view the Path Profile. - **Box Select** - lets you select a particular section of the graph that you wish to view. - The selected box section will be highlighted from the rest of the path profile graph for clear view. - **Zoom In** - lets you zoom in the Path Profile Graph. - **Zoom Out** - lets you zoom out the Path Profile Graph. - **Auto Scale** - lets you auto scale the axes of the graph. - **Reset Axes** - resets the axes as per the original graph. - **Show Closest Data on Hover** - shows you the closest data from the point on the graph where you hover. - The closest path coordinate will be displayed as below: ![Path Profile Tool Closest Data On Hover](Images/InterfaceWeb/PathProfile/Hover.png) - **Compare Data on Hover** - shows you the comparison of the data from the point on the graph where you hover. - The graph comparison will be displayed as below: ![Path Profile Tool Compare Data On Hover](Images/InterfaceWeb/PathProfile/Compare.png) - **Produced with Plotly** - redirects you to the Plotly website. **To Change the Resolution** - Click on **Output** Input Menu. - In the **Resolution** field, select the resolution that you wish to set from the drop-down. **To Change the Building / Clutter Attenuation** - Click on **Clutter** Input Menu. - In the **Clutter Mode** field, select *Soft/NLOS* as the option from the drop-down. - In the **Min attenuation** field, select the Clutter attenuation that you wish to set from the drop-down. ### Fresnel zone Around each link will be a 3D ellipsoid showing the estimated fresnel zone. This cone of power has a direct relationship with frequency/wavelength so a VHF signal has a huge fresnel zone and a SHF signal has a small focused one, like a laser. An ideal link would have an unobstructed fresnel zone otherwise you will be losing power. A viable microwave link needs at least 60% of its fresnel zone to be clear of obstructions. If you are modelling over the sea and a link is near the water you should budget for tides also as these can be more than 10m and will disrupt a marginal link. ![Fresnel zone](Images/InterfaceWeb/PathProfile/FresnelZone.jpg) ### Path Profile KMZ The **KMZ** link on the dynamic chart will download a KMZ path for use in a suitable viewer, such as Google Earth. It contains Tx and Rx placemarks, a 3D fresnel zone and an interactive balloon with a path chart and full metadata from the API if you click anywhere upon the path. ![Path Profile Tool KMZ download](Images/InterfaceWeb/PathProfile/PPAKMZ.png) ### HF Skywave PPA (HF Prediction) When using the HF Skywave propagation model, the PPA chart output is different. Rather than showing you the signal values across the link, instead a static chart is displayed which shows you predicted signal values at varying frequencies spread across a 24 hour period. This can allow for you to choose the best frequency for your application. ![HF Skywave PPA on UI](Images/InterfaceWeb/HFSkywave/UIDisplayPPA.png) The below chart shows an example of what can be downloaded by clicking on the "PNG" link in the top left of the chart viewer. ![HF Skywave PPA Chart](Images/API/hf_prediction_demo.png) ## ![Best server tool icon](Images/InterfaceWeb/Icons/BestServerTool.png) Best Server Tool The **Best Server Tool** is useful for checking coverage against an established network. A typical use case for this would be a Wireless Internet Service Provider (WISP) who want to check ZIP codes or properties for coverage. ![Best Server Tool](Images/InterfaceWeb/BestServer/Response.png) To use the **Best Server Tool**: - Click on the **Best Server Tool** ![Best server tool icon](Images/InterfaceWeb/Icons/BestServerTool.png) button on the Function Menu. - The *Best Server Tool* dialog box will appear. - Site your **Transmitter** location on the map. - **Select a network to test coverage** at the set transmitter location from the drop-down. - Click on **Check Coverage** button. - The **Network Coverage** as per your transmitter location will be reflected on the map. - You can change your transmitter location on the map to check the **best server location and the network coverage**. ## ![Archive icon](Images/InterfaceWeb/Icons/Archive.png) My Archive **My Archive** lets you view the list of your saved networks and their details. It's also where you can download data in open GIS formats like KML, KMZ, SHP, GeoTIFF and HTML. - Click on **My Archive** ![Archive icon](Images/InterfaceWeb/Icons/Archive.png) button on the Function Menu. - The *My Archive* dialog box will appear, where you can see saved calculations which have been previously made. ![My Archive](Images/InterfaceWeb/Archive/DefaultView.png) ### Searching and filtering by network You can select and filter the Network(s) to reduce the entries in your table. This allows you to quickly recover a project or find MESH or MANET networks which are tagged with these network names. - Select the desired **Network** from the drop-down. - The list of networks will be displayed. - Select a network to filter results to those tagged sites only - You can then find a specific site(s) with the **Search box** on the right side - The **filtered entries** will be displayed. ![My Archive Filtered](Images/InterfaceWeb/Archive/Filter.png) ### Sorting You can sort the Network entries in ascending or descending order as per your requirement. To do so: - Click on the **Sort** ![Sort unselected icon](Images/InterfaceWeb/Archive/SortUnselected.png) icon of the respective column. - The sorted entries will be displayed in the table. > ![Sort ascending icon](Images/InterfaceWeb/Archive/SortAscending.png) indicates Sorting in the **Ascending** Order. > > ![Sort descending icon](Images/InterfaceWeb/Archive/SortDescending.png) indicates Sorting in the **Descending** Order. ### Functions Various **Function Icons** are also available to aid with managing previous calculations. The tools provided here allow you to interact with individual calculations which have been made previously by your account. ![My Archive Functions](Images/InterfaceWeb/Archive/ToolsOverview.png) You can filter through specific networks by choosing a specific network from the dropdown list. To delete an entire network, select it from the "Network" dropdown and then click on the delete button. Upon clicking on this you will be prompted with confirmation modal window. ![Archive delete network confirmation](Images/InterfaceWeb/Archive/DeleteNetworkModalConfirmation.png) After confirming deletion, the network will be deleted from your account. ![Archive delete network success](Images/InterfaceWeb/Archive/DeleteNetworkModalSuccess.png) #### Individual Calculation Actions There remaining buttons within the archive are related to interacting with a single calculation, and so you should select the checkbox for the calculation you are trying to act upon. For convenience, there is a "Select All" checkbox at the top of the column which all you to easily select all of the checkboxes on the current page. - **Add Coverage Layer(s) to Map** - lets you add the selected network(s) coverage layer(s) to the map. - You can manage (select/deselect) the network site locations by clicking on the respective [layer checkbox](layer_checkbox). - **Add Tower(s) only to Map** - lets you add the tower(s) to the map in the selected network(s). - **KMZ with Local Content** - lets you download the KMZ file with the local content. - **ESRI Shapefile** - lets you download the Coverage zip file consisting of the *DBH*, *PRJ*, *SHP*, *SHX* files of the selected network(s). - **GeoTIFF Export** - lets you download the *GeoTIFF* image of the selected network(s). You can choose either 4326 or 3857 projection. - **Public Link** - lets you view the selected Network(s) in the **Google Map**. ![My Archive Public Link](Images/InterfaceWeb/Archive/PublicLink.png) - **HTML Embed Code** - opens a modal window with a code snippet which you can use to embed the layer on your own web page. Please note that here we make use of Google Maps. You should have your own Google Maps API key to properly embed the code. > All the API parameters of the selected network(s) will be displayed here. If you are a developer, you can directly copy paste this to use it in your code. ![My Archive HTML Embed Code](Images/InterfaceWeb/Archive/EmbedCode.png) - **Delete Selected** - lets you delete the selected Network(s). - When you click on the *Delete Selected* button, the following warning dialog box will appear. ![My Archive Delete Warning](Images/InterfaceWeb/Archive/DeleteSingleModal.png) - Click on **OK** button to confirm. >Please note, that in order to use tools designed for interactions with a single calculation, you must first select the checkbox of the calculations which you wish to interact with. Otherwise, you will be presented with a modal window, indicating that no calculation was selected. ![No layer selected modal](Images/InterfaceWeb/Archive/NoLayerSelected.png) ## ![Super layer tool icon](Images/InterfaceWeb/Icons/SuperLayer.png) Super Layer The super layer tool lets you generate a super layer composed of different layers. The layers can be from the same network or different networks by using whatever visible layers are on the map. Layers must use the same colour schema. - Click on **Super Layer** ![Super layer tool icon](Images/InterfaceWeb/Icons/SuperLayer.png) button on the Function Menu. - The **Super layer** dialog box will appear. ![Super layer dialog box](Images/InterfaceWeb/SuperLayer/Dialog.png) ### Merge network - In the **Select a network to create a super layer from:** field, you can select a network to create a super layer from the drop-down. - In the **Super layer name:** field, enter the desired super layer name. - Click on the **Merge network** button > For further information, click **[here](https://api.cloudrf.com/?version=latest#a6be861a-ed1f-a7ca-9f6d-5630b35cc7a6)**. - The created **Super Layer** will be highlighted on the map and the corresponding checkbox (enabled) will be displayed. ![Mesh Tool](Images/InterfaceWeb/SuperLayer/Merged.png) - You may **enable** or **disable** the *super layer checkbox* as per your requirement. > The super layer will be displayed on the map when the checkbox is enabled and will not be displayed when the checkbox is disabled. ### Merge visible The tool will use the layers which are on the map. These must use the same colour schema. Click on the **Merge visible** button ## ![Interference analysis icon](Images/InterfaceWeb/Icons/InterferenceAnalysis.png) Interference Analysis The Interference Analysis tool generates a special interference layer, showing the interference between two networks. It supports frequency, power and bandwidth so can perform co-site interference studies where systems are separated in frequency but physically nearby. - Click on **Interference Analysis** ![Interference analysis icon](Images/InterfaceWeb/Icons/InterferenceAnalysis.png) button on the Function Menu. - The **Super layer** dialog box will appear. ![Interference Dialog](Images/InterfaceWeb/Interference/Dialog.png) - In the **Signal network:** field, you can select the network you want to analyse. - In the **Noise source:** field, you can select the interference source. - In the **Result name:** field, enter a name to label it in the archive. - Click on the **Go** ![Go icon](Images/InterfaceWeb/Icons/Go.png) button. > For further information, click **[here](/documentation/developer/#/Analyse/interference)**. - The created **Interference Layer** will be highlighted on the map as a new layer. It will enable Signal-to-Noise mode and use the JS.dB colour key. This colour key uses red for bad interference and green for a good signal. ![Interference Layer Screen](Images/InterfaceWeb/Interference/Response.png) **NOTE - Interference analysis requires you to use calculations which have been generated with measured units that include power, such as received power, field strength, SNR, BER and RSRP. If you attempt to analyse calculations which do not include power then they will be removed from the analysis.** ![Calculation removed for wrong units](Images/InterfaceWeb/Interference/CalculationRemovedWrongUnits.png) (function_best_site_analysis)= ## ![Best site analysis icon](Images/InterfaceWeb/Icons/BestSiteAnalysis.png) Best Site Analysis The best site analysis tool is GPU-powered analysis tool to allow you to find the best locations in a large area for a transmitter. Please note that the response from a best site analysis calculation is **NOT** a response of signal strength. Instead it is normalised result which takes an input `bsa` colour schema to show the absolute best locations in an area. Best Site Analysis is used in the following way: - Click on **Best Site Analysis** ![Best site analysis icon](Images/InterfaceWeb/Icons/BestSiteAnalysis.png) button on the Function Menu. - The interface will be converted to Best Site Analysis mode. With this you may notice a number of things: - The small dialog in the top right of the interface indicating you are in Best Site Analysis mode. - The percentage slider in the bottom left of the interface. - "Radius" in the "Output" menu has been disabled. - "Engine" in the "Output" menu has been disabled and set to "GPU". - "Colour schema" int the "Output" menu has been changed to a `bsa` colour schema. ![Best site analysis enabled](Images/InterfaceWeb/BestSiteAnalysis/InterfaceEnabled.png) To use the best site analysis tool you can draw a polygon around an area by making use of left-click on the map to set the points of your polygon. Once you have finished drawing your polygon you can right-click to join up to the first point and set an area. Once you right-click your area will be sent to the Cloud-RF API where it will be handled and return your response. ![Best site analysis 50% to 100%](Images/InterfaceWeb/BestSiteAnalysis/Result50To100.png) You can then use the slider in the bottom left corner to fine-tune your result and show results between certain percentage thresholds. ![Best site analysis 75% to 90%](Images/InterfaceWeb/BestSiteAnalysis/Result75To90.png) This is useful for showing coordinates which meet your threshold, as it allows you to pinpoint the best locations to place your transmitter. Please note that to make use of the Best Site Analysis tool you will require a Gold or Platinum subscription plan. If you do not have either then you will receive a forbidden message for the reponse. ![GPU forbidden response](Images/InterfaceWeb/Response/GPUForbidden.png) ### Satellite NTN LOS analysis (Starlink, Oneweb, Lync) The BSA tool is ideal for LOS analysis for LEO ground terminals as it can recommend the best site for maximum visibility of the sky. As Low Earth Orbit (LEO) satellites are almost omni-directional in the sky, and fast, isolating one or two is impractical. To use BSA for LEO, expand the search perimeter beyond the area of interest and then set the receiver altitude to be higher than local obstructions eg. 30m to achieve a steep angle of incidence. As a rule of thumb, set the receiver height to the search radius to achieve a 1:1 (45 degree) angle. ![Siting a Starlink terminal with 1m LiDAR](Images/InterfaceWeb/starlink_planning.jpg) ## ![Route analysis icon](Images/InterfaceWeb/Icons/RouteAnalysis.png) Route Analysis The route analysis function will let you define a route by clicking upon the map. Points along the route will be tested as transmitters back to your map marker's location which assumes the role of receiver. The transmitter and receiver settings will come from the form. To add a route: - Left click route analysis button. - Left click points on the map to draw a route. A polyline will appear. - Right click to finish the route. Result will appear after a brief delay. - The points are colour coded based upon the selected colour key. - Click the recycle button to remove the layers. **WARNING - Routes are not saved to your database** ![Route Analysis](Images/InterfaceWeb/RouteAnalysis/Response.jpg) ## ![Multipoint Analysis](Images/InterfaceWeb/Icons/MultipointAnalysis.png) Multipoint Analysis The multipoint analysis function will let you define many links quickly by clicking upon the map. Points will be tested as transmitters back to your map marker's location which assumes the role of receiver. The transmitter and receiver settings will come from the form. To add points: - Left click multipoint analysis button. - Left click points on the map to draw links. - The points are colour coded based upon the selected colour key. - Click the recycle button to remove the layers. **WARNING - Multipoint links are not saved to your database** ![Multipoint Analysis](Images/InterfaceWeb/MultipointAnalysis/Response.jpg) (manet_planning_tool)= ## ![MANET planning tool icon](Images/InterfaceWeb/Icons/MANET.png) MANET planning tool The Mobile Autonomous Network (MANET) planning tool lets you rapidly define a MANET network composed of indepdendent nodes. Nodes can have distinct configurations so you can simulate different radios and/or antennas together. To create a MANET network: - Define or select a template for your radio - Left click the MANET button. - Left click on the map to add a node / radio. - The nodes will use the settings defined in the input menu. If you need different settings, make the change then add the node. - Drag a node to move it to a better location - Right click a node to delete it ![MANET network](Images/InterfaceWeb/MANET/Network.png) You can configure options for the "MANET Metrics" modal in the bottom left of the screen by clicking on the settings cog icon which is located to the right of this "MANET Metrics" heading. ![MANET settings cog icon](Images/InterfaceWeb/Icons/MANETSettings.png) When you select the settings then this will open up a modal where you can configure a number of settings: ![MANET settings modal window](Images/InterfaceWeb/MANET/SettingsModal.png) - **Measured units** drop down allows you to select the measured unit which is being used to calculate your MANET network links. Default is Received Power but you can set SNR here also. - The bar chart thresholds allow you to dynamically configure the QoS thresholds for your MANET network so you can model efficiency for different waveforms or requirements eg. video. - **Show links** allows you to enable coloured links between network nodes. A link will be shown if it exceeds your receive threshold - otherwise it will not be drawn. - **Show heatmap** shows you a coverage heatmap for all the MANET network ndoes, out to the defined threshold. This uses the GPU engine so a premium plan is required. Below shows an example of a MANET network with both links and heatmap enabled. ![MANET network with both links and heatmap](Images/InterfaceWeb/MANET/LinksAndHeatmapEnabled.png) **NOTE - Heatmaps are GPU accelerated and require a Gold subscription.** ### MANET layer controls The links and heatmap layers can also be toggled on and off by clicking the relative icons in the top right corner of the MANET dialog. ![MANET layer controls](Images/InterfaceWeb/MANET/MANETQuickLayers.png) ### Saving and loading MANET networks The MANET network is auto-saved after every re-calculation. A re-calculation is performed when a node is added, removed or added. Unlike other API calls, MANET networks are saved to a file instead of the database due to their complexity. This will appear in your archive under the **MANET** network and can be reloaded by selecting it and choosing to add it to the map. You can choose to reset or merge with existing MANET networks. This allows you to merge two puddles of radios. Please note that you will only be prompted with this window if you have existing MANET nodes already on the map. ![MANET load options](Images/InterfaceWeb/MANET/LoadOptions.png) ### Downloading a MANET network A network can be downloaded as either KMZ, SHP, GeoTIFF, URL or HTML from either the bottom left menu directly after completion, or via the archive using the standard workflow for fetching files. ## ![Satellite planning tool](Images/InterfaceWeb/Icons/Satellite.png) Satellite planning tool The Satellite planning tool lets you test for visibility to over 5400 active satellites from a database. Unlike sat-finder apps this considers topography and clutter to determine visibility. To test a point for satellite visibility: - Left click SATELLITE button. - Enter search parameters eg. STARLINK in the search popup - The results will be listed. Click the satellite of interest - The satellite will now be added above the earth on an orbit which you control the time of using the time slider at the bottom of the screen. - Use the multipoint tool to test points by clicking on the earth. ![Satellite point](Images/InterfaceWeb/Satellite/Points.png) To test a route for satellite visibility: - Left click SATELLITE button. - Enter search parameters eg. STARLINK in the search popup - The results will be listed. Click the satellite of interest - The satellite will now be added above the earth on an orbit which you control the time of using the time slider at the bottom of the screen. - Use the route tool to test a route by left-clicking a path upon the earth then right clicking to finish. ![Satellite route](Images/InterfaceWeb/Satellite/Route.png) ### Satellite NTN LOS analysis (Starlink, Oneweb, Lync) The Best Site Analysis (BSA) tool is ideal for LOS analysis for LEO ground terminals as it can recommend the best site for maximum visibility of the sky. As Low Earth Orbit (LEO) satellites are almost omni-directional in the sky, and fast, isolating one or two is impractical. To use BSA for LEO, expand the search perimeter beyond the area of interest and then set the receiver altitude to be higher than local obstructions eg. 30m to achieve a steep angle of incidence. As a rule of thumb, set the receiver height to the search radius to achieve a 1:1 (45 degree) angle. ![Siting a Starlink terminal with 1m LiDAR](Images/InterfaceWeb/starlink_planning.jpg) ## ![Clear layers icon](Images/InterfaceWeb/Icons/ClearLayers.png) Clear Layers The recycle icon will clear and reset the map of all layers. The layers can be reloaded from within your archive. To clear the layers on the map: - Click on **Clear Layers** ![Clear layers icon](Images/InterfaceWeb/Icons/ClearLayers.png) button on the Function Menu. - All the layers on the map will be **cleared** and **reset**. - The required layers can be reloaded from the *Archive*.