Support

Bandwidth Monitor Help

The following help topics were originally written in 2006 and haven't been regularly updated since. With this in mind, please see the bottom of the page for directions on how to contact me directly if the help topics don't manage to answer your questions.

General

What's New?

Bandwidth Monitor 2 introduces a number of new features from its predecessor Bandwidth Monitor 1.0. Below is a short summary of the new features to be found in Bandwidth Monitor 2

Themes

Graphs

Broadcasts

Notifications

Hosts View

Plus dozens of extra new features in addition to the existing improved features which were so popular in Bandwidth Monitor 1.0.

Getting Started

To get started with Bandwidth Monitor, you should choose the feature-list which best suits your application of the program. Many features can be found in our Free Edition. Advanced features such as Broadcasts and Notifications are only found in the Professional Edition.

To install the software, download the file to your desktop or another memorable location. Launch the setup application by double clicking the file

Follow the instructions given in the setup application and Bandwidth Monitor will be copied to your computer's hard drive. You may have the option to run the program when setup completes.

Professional Edition Users will need to enter their serial number when Bandwidth Monitor first runs. This is to verify that you are the registered owner of Bandwidth Monitor Professional Edition.

(Why does my firewall ask if Bandwidth Monitor is allowed to connect to the internet?)

Answer: There are two reasons. If you are registering your edition of Bandwidth Monitor Professional Edition, Bandwidth Monitor will connect to the licence server at www.rokario.com to register your licence. This is to enable to us to keep better track of each serial number's usage (This is for statistical purposes only; no personal data is collected during this process). The second reason may be that Bandwidth Monitor is set to automatically check for updates by default. This option can be disabled by right clicking Bandwidth Monitor and choosing "Settings". You can find the auto-update check option in the General page.

Themes

Loading

To load a theme in Bandwidth Monitor, right click the application and navigate through Themes --> Select. Click the theme that you wish to load

Any changes to your existing theme will be saved before the new theme is loaded.

The themes menu is populated by examining all folders within the /Themes/ folder in your Bandwidth Monitor main directory. Each theme must have a valid 'repositary.xml' file to be loaded. If there is a problem with your repositary file for a selected theme, the application will fail to load it and a default theme may be loaded instead.

Creating

To create a new custom theme, right click the application and navigate through Themes --> Create New

In the prompt dialog, enter a new name for your theme. (Avoid special characters and names of themes which already exist). Click OK to accept the new theme name.

You are presented with a blank window. To begin the design process, right click the application and navigate through Themes --> Design Active. (Alternatively, press F2 on your keyboard). The designer window appears.

Designing

To demonstrate the use of the theme designer, here we will take a closer look at the 'Standard' theme which ships by default on all bundles of Bandwidth Monitor 2.

To access the designer as above, press F2 on your keyboard. Alternatively, right click and navigate through Themes --> Design Active. (If the Default theme is not already your active theme, you must load it for the purpose of this demonstration.

The designer paints a representation of the elements which exist in the designing theme. Each element is represented by a bounding box, with some shade of purple.

The intensity of the purple denotes how close the element is to the front of the theme, that is; the boldest purple elements will be painted on top of less bold elements. This 'depth-cue' system is designed to enchance clarity in the designer

Clicking an element highlights it in green. While the mouse button is held down, the coordinates and dimensions of the element are displayed in the bottom left hand corner of the bounding box.

In addition, while the mouse button is depressed, you may drag the element around the designer to alter its position. The changes are reflected in real-time on the main display to give an indication of how the change will appear. To paint a preview of the element content within the designer, click the 'Preview' button on the designer window (Denoted by a magnifying glass). With this mode enabled, the element is painted underneath the bounding box.

Elements can be brought backwards and forwards by right clicking them and choosing as appropriate.

To change the appearance of the physical Bandwidth Monitor window, choose "Edit Elements" (denoted by a Cog-Wheel icon) and select "Edit Background..". Here you may change the colour and appearance of the Bandwidth Monitor window itself. Similarly, you may edit any attribute of selected theme elements by selecting it and choosing "Edit Selected.." (or double click the desired element).

Managing

Themes created with Bandwidth Monitor 2 are stored in

{Main Program Directory}\Themes

By default, this directory will be at C:\Program Files (x86)\Rokario\Bandwidth Monitor\Themes

To view the theme manager within Bandwidth Monitor, right click the application and navigate to Settings. At the settings dialog, click the Themes page to view all available themes. From here you may create new themes, delete themes from your computer or set new default themes

Elements

Text

Text elements are used to display any data items in a formatted way. Use the text element editor to change the font styles, colours, line spacing and contents. Here is an example of a text element configuration:

Text elements can represent any type of data tag and are supported for use in broadcast pages.

Images

Image elements contain data from Icon, Bitmap, or JPEG files on your computer

Image elements are supported for use in broadcast pages.

Graphs

Graph elements are designed to represent numerical data in a generic form. Use graphs to monitor real-time data over a maximum period of 500 seconds. The graph configuration pages appear as follows:

You may manually specify the size of the Y (data) scale by using the 'Maximum Data Axis Size' option. If you wish to have the scale automatically resize depending on the data supplied to it, check the box below which begins 'Automatically resize axis'. With this setting enabled, graph scales are handled automatically by Bandwidth Monitor

To specify the range of the graph plot buffer, use the 'Plot Buffer' counter. This value is measured in seconds. If a value of 60 is used in this field, the graph will take precisely one minute to cycle data items. Shorter values will produce shorter and blockier graphs.

To enable a graph to be partially transparent, use the 'Transparency' slider. Transparency affects the graph scales in addition to the graph plot area. If no background is defined on the graph, only the data area and scales will take on transparent properties.

(Recommended) Use the 'Anti-Alias' option to smooth the edges of graphs. With this option disabled, graphs may appear more jagged but may optimize CPU load on very *very* slow systems.

Use the background style and colour options to define a colour to fill the background of the graph. If style is set to Transparent, no background will be drawn (any element under the graph will be visible)

Use the border style options to define a border to draw around the graph area. Note: Dotted and Dashed borders will not draw to any thickness greater than 1 pixel

To draw graph scales, check the 'Show scale numbers' option. With this setting enabled, a graph data scale will be drawn on the left hand side of the graph area. You may define the font and colour of this scale using the options below. Note: Graph scales are drawn un-anti-aliased for readability purposes with small fonts

Use the plots tab to define graph plots and their colours. Graph plots may accept any numerical value - use the tag-list on the right of the dialog to drag data items into graph plot values. You may use standard static numbers however this would not produce particularly meaningful results.

Click 'Add' to add a plot to the list. Order your plots using the 'Send Backward' and 'Send Forward' buttons. Note: To edit a plot you must delete the old and insert a new, since plots are not defined uniquely by a name

Shapes

Shape elements provide a method of drawing basic shape primatives in a theme. Use the element design page to alter shape, colour and border styles.

Shapes do not accept any data tags as parameters.

Settings

Overview

To access the settings dialog, right click the application and navigate to Settings.

The settings dialog allows you to specify various options and methods of operation within Bandwidth Monitor.

Overview

Always on top: Enable this option to force Bandwidth Monitor to always be the top-most application on your desktop. This feature is complemented by the click-through mode (see further down).

Exist in Windows system tray: Enable this feature to place an icon in your Windows system tray. With this option enabled, the application will minimize entirely to the system tray. While the Bandwidth Monitor is minimized the theme is not rendered, to save on CPU cycles. Data is always still collected whilst minimized.

Minimize on Startup: If this option is enabled, Bandwidth Monitor will minimize when it first starts up.

Snap to edges of screen: If this option is enabled, Bandwidth Monitor will become attracted to the edges of your screen as you move it around the desktop. The snap threshold is 10 pixels.

Load on Windows Startup: Enable this option to have Bandwidth Monitor load on Windows startup.

* Enable click-through mode: * Professional Edition only. With this option enabled, Bandwidth Monitor will behave as a transparent entity - enabling you to manipulate windows underneath the monitor as if it were not there. This feature is complemented by the Always-on-top feature (see above).

* Enable balloon messages: * Professional Edition only. Enable this to allow Windows 2000/XP balloons to be created on selected events.

Automatically Check for updates: Use this option to have Bandwidth Monitor automatically check for updates when it loads.

Show drop shadow: This option creates a drop-shadow underneath the main application window.

Dim on task switch: With this option enabled, the application will dim by the specified amount when its status as active Window is revoked. It will un-dim when focus is restored to Bandwidth Monitor.

Dim after idle: Similar to the above, this option will dim Bandwidth Monitor after a given period of idle usage.

Manipulate the data-averaging slider to ajust the accuracy of live data measurements in Bandwidth Monitor. Data calculated with less averaging will produce 'spikier' graphs than more averaged data.

You may choose how many decimal places Bandwidth Monitor performs its calculations to by altering the value at the bottom of this page.

Use the theme manager to keep track of your themes

Use the notification manager (Professional Edition only) to define notification events.

Notifications

Creating

Notifications occur when a particular value matches a given criteria. These are useful for monitoring extreme situations on adapters, for example; a situation where an adapter is persistantly consuming more than 10Mbit/sec of data may require attention by the system administrator.

Use the Delete button to remove unwanted notifications. Clicking the 'Data Items' button launches a tool-window with draggable data tags.

To create a new notification, enter a data value to observe in the 'Data Value' field. This value is usually a data tag such as %Adapter:MbinInPerSec%

Next, select a comparison condition from the drop-down list.

In the 'Comparison' field, enter the value which your observed data should be compared to. This value may be a data tag. Note: Dates cannot be compared

Select the frequency of notification in minutes.

Finally, enter the text to be displayed in the bubble when this notification is executed. This text may contain any combination of data or tags.

Click 'Add' to add the new notification.

Note: Balloon messages must be enabled in Settings for notifications to work.

Logs

Managing

Bandwidth Monitor automatically creates log files of activity on all adapters, by default. Logs are stored in the /Logs folder of the main application directory and use a filename of the MAC Address of the adapter they represent.

To prevent Bandwidth Monitor from monitoring a specific adapter, right click Bandwidth Monitor and navigate to 'Logs'. Select the adapter from the drop-down menu at the top of the Log manager, and de-select "Enable logging on this adapter". Press OK to apply this change. Bandwidth Monitor will no longer make logs for this adapter.

To import a log file (either from Bandwidth Monitor 1.0 or from an alternative source), use the Import button. Importing a log file will automatically delete any existing log contents for the selected adapter.

Use 'Delete All' to clear a log file completely.

Viewing

To view adapter logs, right click Bandwidth Monitor and navigate to 'Logs'. Use the log manager dialog to view your logs and, in the Professional Edtition only, make changes to your logs manually.

Cleanup

To clean up adapter logs, use the 'Cleanup' button in the Log Manager (Professional Edition only).

The cleanup utility will delete either uploaded, downloaded, or both data items which come before a given time frame. This is particularly useful if your interest lies only with data concerning the most recent week, month or other specific timeframe.

Broadcasts

HTTP

Professional Edition Only.

HTTP Broadcasts provide a web-server to access real-time Bandwidth Statistics. Customize the Bandwidth Monitor web server pages by editing the files in the broadcast folder (to find this folder, navigate to 'Broadcasts' from the main menu and click "Go to Broadcasts")

To create a HTTP broadcast, right click Bandwidth Monitor and navigate to 'Broadcasts'

From this broadcast manager, you may create, delete and modify broadcasts on your system. In addition, you may design the elements which could appear in your broadcasts.

Ensure that the 'Enable Broadcasts' option is enabled, and click 'New' to begin adding a new broadcast. Select HTTP from the types drop-down menu, and choose a port range to run the broadcast on. Note: Bandwidth Monitor will open a maximum of 16 ports on all broadcasts combined.

You may limit each broadcast to a fixed number of clients by using the option labelled 'Limit broadcasts to'.

To ban an IP address or range of IP addresses from accessing your broadcasts, use the 'Deny Hosts' option on the broadcasts manager. Entries may be given as either IP addresses or resolved host names. Use the wildcard operator * to specify ranges of entries.

You can specify graphs and other elements to be made available to your broadcast web pages. Use the 'Repositary' tag to define elements for broadcast usage. Selecting any element in the list will provide source code at the bottom of the page; this source code can be pasted directly into your favourite HTML editor. Additional: To use elements from your theme, use the syntax <img src="@Theme:Element Name@">

You may choose a degree of image compression strength in the 'HTTP' tab of the broadcast manager.

Data

Professional Edition only. Data broadcasts are used for translating data tags (usually from other software). This is an advanced feature and some knowledge of client/socket programming is assumed.

To create a Data broadcast, right click Bandwidth Monitor and navigate to 'Broadcasts'

From this broadcast manager, you may create, delete and modify broadcasts on your system.

Ensure that the 'Enable Broadcasts' option is enabled, and click 'New' to begin adding a new broadcast. Select Data from the types drop-down menu, and choose a port range to run the broadcast on. Note: Bandwidth Monitor will open a maximum of 16 ports on all broadcasts combined.

You may limit each broadcast to a fixed number of clients by using the option labelled 'Limit broadcasts to'.

To ban an IP address or range of IP addresses from accessing your broadcasts, use the 'Deny Hosts' option on the broadcasts manager. Entries may be given as either IP addresses or resolved host names. Use the wildcard operator * to specify ranges of entries.

Data broadcasts work by running a server socket to listen for clients, and respond to data requests. Below is a list of supported protocol commands and their syntax, plus expected replies. This list may change over time:

ECHO

This command returns the given string (short strings expected) with any data tags translated correctly.

Example:

(Client) ECHO %Times:Day%
(Server) ECHO :Tuesday

Hosts Window

Overview

(Professional Edition only). The hosts dialog provides details of all the connections currently being made to your computer (TCP only).

Note: This feature is equivelant to using the Windows console command 'netstat'. To access the Hosts dialog, right click Bandwidth Monitor and navigate to 'Hosts'



Press 'Refresh' to re-populate the hosts dialog

Data Tags

Dictionary

This list shows all currently supported data tags within Bandwidth Monitor, and a description of their purpose.

Tag Description
%APP:Path% Returns the working data path (not the executable's location)
   
%TIMES:Time% Returns current system time
%TIMES:Date% Returns current system date
%TIMES:Day% Returns the day name, e.g. Monday
   
%ADAPTER:Name% Returns active adapter's name
%ADAPTER:Speed% Returns active adapter's speed in Mbit/sec
%ADAPTER:MbitInPerSec% Returns active adapter's current download speed in Mbit/sec
%ADAPTER:MbitOutPerSec% Returns active adapter's current upload speed in Mbit/sec
%ADAPTER:KbitInPerSec% Returns active adapter's current download speed in Kbit/sec
%ADAPTER:KbitOutPerSec% Returns active adapter's current upload speed in Kbit/sec
%ADAPTER:MBInPerSec% Returns active adapter's current download speed in Megabytes/sec
%ADAPTER:MBOutPerSec% Returns active adapter's current upload speed in Megabytes/sec
%ADAPTER:KBInPerSec% Returns active adapter's current download speed in Kilobytes/sec
%ADAPTER:KBOutPerSec% Returns active adapter's current upload speed in Kilobytes/sec
%ADAPTER:MBBothSinceReboot% Returns megabytes downloaded and uploaded on active adapter since last reboot
%ADAPTER:MBInSinceReboot% Returns megabytes downloaded on active adapter since last reboot
%ADAPTER:MBOutSinceReboot% Returns megabytes uploaded on active adapter since last reboot
%ADAPTER:GBBothSinceReboot% Returns gigabytes downloaded and uploaded on active adapter since last reboot
%ADAPTER:GBInSinceReboot% Returns gigabytes downloaded on active adapter since last reboot
%ADAPTER:GBOutSinceReboot% Returns gigabytes uploaded on active adapter since last reboot
   
%ARCHIVE:TBBothThisYear% Returns terabytes downloaded and uploaded on active adapter this year
%ARCHIVE:TBInThisYear% Returns terabytes downloaded on active adapter this year
%ARCHIVE:TBOutThisYear% Returns terabytes uploaded on active adapter this year
%ARCHIVE:GBBothThisYear% Returns gigabytes downloaded and uploaded on active adapter this year
%ARCHIVE:GBInThisYear% Returns gigabytes downloaded on active adapter this year
%ARCHIVE:GBOutThisYear% Returns gigabytes uploaded on active adapter this year
%ARCHIVE:TBBothThisMonth% Returns terabytes downloaded and uploaded on active adapter this month
%ARCHIVE:TBInThisMonth% Returns terabytes downloaded on active adapter this month
%ARCHIVE:TBOutThisMonth% Returns terabytes uploaded on active adapter this month
%ARCHIVE:GBBothThisMonth% Returns gigabytes downloaded and uploaded on active adapter this month
%ARCHIVE:GBInThisMonth% Returns gigabytes downloaded on active adapter this month
%ARCHIVE:GBOutThisMonth% Returns gigabytes uploaded on active adapter this month
%ARCHIVE:TBBothThisWeek% Returns terabytes downloaded and uploaded on active adapter this week
%ARCHIVE:TBInThisWeek% Returns terabytes downloaded on active adapter this week
%ARCHIVE:TBOutThisWeek% Returns terabytes uploaded on active adapter this week
%ARCHIVE:GBBothThisWeek% Returns gigabytes downloaded and uploaded on active adapter this week
%ARCHIVE:GBInThisWeek% Returns gigabytes downloaded on active adapter this week
%ARCHIVE:GBOutThisWeek% Returns gigabytes uploaded on active adapter this week
%ARCHIVE:GBBothToday% Returns gigabytes downloaded and uploaded on active adapter today
%ARCHIVE:GBInToday% Returns gigabytes downloaded on active adapter today
%ARCHIVE:GBOutToday% Returns gigabytes uploaded on active adapter today
%ARCHIVE:MBBothToday% Returns megabytes downloaded and uploaded on active adapter today
%ARCHIVE:MBInToday% Returns megabytes downloaded on active adapter today
%ARCHIVE:MBOutToday% Returns megabytes uploaded on active adapter today
%ARCHIVE:GBBothThisHour% Returns gigabytes downloaded and uploaded on active adapter in the current hour of day
%ARCHIVE:GBInThisHour% Returns gigabytes downloaded on active adapter in the current hour of day
%ARCHIVE:GBOutThisHour% Returns gigabytes uploaded on active adapter in the current hour of day
%ARCHIVE:MBBothThisHour% Returns megabytes downloaded and uploaded on active adapter in the current hour of day
%ARCHIVE:MBInThisHour% Returns megabytes downloaded on active adapter in the current hour of day
%ARCHIVE:MBOutThisHour% Returns megabytes uploaded on active adapter in the current hour of day
   
%BROADCAST:ClientCount% Returns the number of clients connected to broadcasts on the system

Contact Me

If the support articles above don't manage to answer your questions, feel free to contact me directly by clicking here. I'll try to reply as quickly as I can (usually within 48 hours).