STREAMbox Web Information Page


Version 2.10

Contents

Introduction - terminology and basic function of the STREAMbox.

Web Information Page – description of the values on the Web Information page.

Diagnostics – how to analyse and fix issues with the STREAMbox.

Changing the STREAMbox's settings – how to change and recover the STREAMbox.

Dumping data to USB memory – how and when to dump raw data to USB.

Healthcheck – perform an automatic check of the system parameters and error logs.

Update Software – install software updates from the Software Update Server.

Restore Previous Release – restore the previous version of software and settings.

Restore Factory Defaults – reset all software and settings back to factory defaults.

Force a Rescan – request a full rescan of the scan range.



Introduction

The purpose of the STREAMbox's Web Information Page is to assist the user to determine whether the STREAMbox is working normally and if it isn't, where the cause of the problem may be. To get the most out of this guide it would help to understand a little of how the STREAMbox works and some of the terminology we use:

Telemetry Device (TD): This is the generic term for devices such as solar controllers or PV inverters. It describes a device that monitors, and usually controls, a collection of transducers such as temperature and flow sensors.

LAN Interface Device (LID): This is the generic term for devices such as a Bootloader, Datalogger or Sunny WebBox. It describes a device that collects the information from one or more Telemetry Devices and presents it to the LAN (Local Area Network).

Serial Interface: Many Telemetry Devices, such as PV inverters, can be accessed directly by the STREAMbox through a Serial Interface. This can be a cable connected directly from one of the COM ports to the device or via a small adapter.

Network Interface Device (NID): This is the generic term for devices such as network routers, network switches and network hubs. It describes a device that connects your LAN to the outside world or internet. The name is confusingly close to LAN Interface Device, but it has a very different function.

STREAMbox: This is a small computer which connects to the LAN and/or Serial Interfaces and searches for LAN Interface Devices and/or serial devices. It then scans the devices it finds and pushes their data to the Splash Monitoring web site.

Scan process: This is a program on the STREAMbox that searches a range of IP addresses and/or serial devices. For each device it finds it creates an entry in its local database and scans those devices at a designated scan frequency. It stores information locally for each TD connected.

Push process: This is a separate program on the STREAMbox which monitors the local database, and pushes any TD data it finds out to the Splash Monitoring web site. This means that in the event of an internet access failure, the scan process can continue scanning LIDs and storing the data on the STREAMbox independently of the state of the internet. When the internet connection is restored the push process works as quickly as it can to push the collected data to the web site until it catches up with the scan process. Clearly the time it takes to catch up with the scan process will depend on how long the internet has been out of service.

Human Interface Device: This is the generic term for devices such as keyboards, mice, screens and so on. The STREAMbox comes with no such devices, this is because we strive to make it as simple and cost-effective as possible, and in most cases we achieve this. However, the real world is sometimes not so simple and we need to change things. More about this later.



Web Information Page

This page displays information about how your STREAMbox is performing and is a useful diagnostic tool in the event that you can't see your data on the Splash Monitoring web site.

Firstly note this page is a snapshot in time, it does not automatically refresh, so you need to note the snapshot date and time in the page header. To update the information on this page click your browser's refresh button.

To display the Web Information Page:

If you are using a static IP address on the STREAMbox enter this into your Web browser's address line. If the STREAMbox is configured to use DHCP enter http://splash into your browser's address line. This doesn't always work, some routers store the hostnames of their DHCP clients in its lease tables, however if yours doesn't then it gets a bit trickier.

You could connect a VGA screen to the back of the STREAMbox and at the end of the boot sequence its IP address is displayed. Or you could try to guess its IP address by first establishing your PC's IP address (assuming it is set to acquire a DHCP address), then try entering neighbouring addresses into your browser until you find the Web Information Page.


Devices Found:

This table sets out information for each device the STREAMbox has found. If no devices are detected for whatever reason this table will contain the message "No devices found"

Address: This is either the LID's IP address or the serial interface. Device Type: The type of device.

Sys: This is the system number you will see when you 'scan' the fingerprint on the SPLASH Monitoring Web Site.

Last Scanned Data: the most recently scanned raw data for each Telemetry Device.

When a TD is first recognised by the STREAMbox it is assigned a unique device number, this is the first number displayed in square brackets ie. [0]. The next two fields are the date and time of the scan, and the subsequent comma separated fields are the data values from the TD. These fields are displayed in the same order as you will see them on the web site. There are no units associated with these fields because it is raw data and you need to ascertain what each value represents by comparing them with the instantaneous data available from each TD. Displaying a TD's data is obviously device specific and is described in the manufacturer's documentation.

Last Pushed Data: This is the data most recently pushed to the Splash Monitoring web server for each TD. There is a Timestamp field followed by comma separated data fields in the same order as the scan data.


Scanning Information:

Scan Cycle: This is the frequency in seconds that the STREAMbox scans your devices. The factory default setting is 10 seconds.

Rescan Cycle: This is the frequency in seconds that the STREAMbox rescans the IP range for new or missed LIDs, or existing LIDs for new TDs. Sometimes these devices are not on line or not responding when the STREAMbox first scaned the LAN, therefore we should do an occasional rescan to find them. The factory default setting is 24 hours or 86,400 seconds. You can force a re-scan at any time by power cycling the STREAMbox or selecting a rescan at the foot of the Web Information Page. Serial devices are automatically rescanned every 5 minutes.

TX data compression: If you have lots of TDs connected to your STREAMbox (more than ten is a guideline) then selecting this option will compress the data before sending it to the Web server. Compressing the data will usually reduce its volume by a factor of about 8 to 10, thus reducing the load on the LAN/Internet. However, because of the way the compression algorithm works, setting this to 'yes' with only a small amount of data may actually increase its volume.

1st IP in Scan Range: This is the first IP address the STREAMbox will scan for LIDs. By default this is [network].210 where [network] corresponds to the first three octets of the IP address assigned to eth0. ie. where eth0 = 192.168.0.105, first scan range = 192.168.0.210

Last IP in Scan Range: This is the end of the range of IP addresses the STREAMbox will scan for LIDs. By default this is [network].219 where [network] corresponds to the first three octets of the IP address assigned to eth0. ie. where eth0 = 192.168.0.105, last scan range = 192.168.0.219

By default the STREAMbox will also scan the range 192.168.66.210 to 192.168.66.219. This range was selected to avoid conflicting with most domestic router's DHCP range.

If your first and last IP addresses are blank then it is set to scan the default ranges above and has not been manually modified. If you see different values in these fields, then the defaults have been manually overriden.

Therefore LAN Interface Devices must be assigned static IP addresses within the range defined here.

Other Addresses: This table contains either a list of individual IP addresses the STREAMbox is required to scan, or a number of serial interface descriptors, or a mixture of both. These can be either in addition to the scan range described above, or instead of if the scan range is blank. This table won't be displayed if there are no individual addresses assigned. Use the 'Change Settings' button at the foot of the Web Information Page to assign these addresses.

The STREAMbox can be forced to automatically scan for any known devices connected to any available serial port. This will take about 40 minutes on initial start-up and assumes the baud rate, parity and stop bits on all connected devices remain at factory default settings. To force a serial scan enter 'do-serial-scan' into one of the 'Other Addresses'. The auto-scan will be performed only once when the STREAMbox is next power cycled, any devices found will be remembered and scanned automatically. To repeat the auto-scan you will need to re-enter 'do-serial-scan' into the 'Other Addresses'.

Valid serial interface descriptors are currently:

  1. "do-serial-scan": perform an automatic scan of all serial interfaces.

  2. "si-sma-com1": SMA inverters connected directly to COM1.

  3. "si-sma-com2": SMA inverters connected to COM2 via RS485 adapter.

  4. "si-sma-usb1": SMA inverters connected to USB1 via RS485 adapter.

  5. "si-samil-ser": Samil inverters connected to any of the COM or USB ports via RS422 adapter.

  6. "si-steca-ser": Steca inverters connected to any of the COM or USB ports via RS422 adapter.

  7. "si-aurora-com1": power-one inverters connected directly to to COM1.

  8. "si-aurora-com2": power-one inverters connected to COM2 via RS485 adapter.

  9. "si-aurora-usb1": power-one inverters connected to USB1 via RS485 adapter.

  10. "si-selectronic-ser": Selectronic inverters connected to COM2 or any of the USB ports.

  11. "si-ingen-ser": Ingenieurburo weather stations connected to any of the COM or USB ports via RS422 adapter.

  12. "si-sunverge-net": Sunverge SISs connected via the internet over the LAN.

  13. "si-daikin-ac": Daikin heatpump connected to any of the COM or USB ports via RS422 adapter.

  14. "si-delta-ser": Delta inverters connected to COM1 or any of the USB ports via RS422 adapter.

  15. "si-kaco-ser": Steca inverters connected to any of the COM or USB ports via RS422 adapter.

  16. "si-midnite": Midnite inverters connected to the LAN.

  17. "si-nehub": Neohub home automation controller connected to the LAN.

  18. "si-zever-ser": zeversolar inverters connected to any of the COM or USB ports via RS422 adapter.

Please Note: Only one manufacturer's devices can be scanned on a single serial interface. Any combination of manufacturers can be scanned on different serial interfaces and/or LAN interfaces. Devices must not be scanned simultaneously on any two interfaces (ie. don't connect an inverter to both a serial interface and a LAN Interface device). Similarly, most serial devices will only tolerate one 'master' interrogation device on the same serial bus. In other words don't connect a LAN Interface Device or any other manufacturer's data logger to the same serial bus as the STREAMbox, there can only be one device on the bus doing the data collecting.


Network Information:

eth0 IP: This is the IP address the STREAMbox uses to communicate with the Internet. By default it is allocated by your DHCP server (usually a service provided by your router). If there is no network configured on eth0:1 then this is also the address used to scan for Lan Interface Devices.

eth0:1 IP: By default this IP address is set to 192.168.66.123 to scan the secondary default range 192.168.66.210 to 192.168.66.219. If you need to scan LIDs on a different network then you can set it up using the 'Change Settings' button at the foot of the Web Information Page.

Subnet Mask: These are the subnet masks associated with each of the STREAMbox's LAN interfaces. By default assigned by DHCP.

Gateway: This is the IP address of the gateway to the internet (usually the router's IP address), it is essential for communication to the outside world. By default DHCP assigns this, but if DHCP isn't used then you must set this using the 'Change Settings' button at the foot of the Web Information Page.

DNS: This is the IP address of the DNS server (usually the router's IP address), it is essential for communication to the outside world. By default DHCP assigns this, but if DHCP isn't used then you must set this using the 'Change Settings' button at the foot of the Web Information Page.

Data RX Rate: This is the average number of megabytes per hour that the STREAMbox has received since it was powered on. The vast majority of this traffic will be as a result of interrogating LIDs.

Data TX Rate: This is the average number of megabytes per hour that the STREAMbox has transmitted since it was powered on. The vast majority of this traffic will be as a result of sending data to the Splash Monitoring web site.


Software Version Information:

Fingerprint: This is the unique key assigned to your STREAMbox and it is what the Splash Monitoring web site uses to authenticate received data and assign it to your 'systems'.

Release Number: This is the generic version number for the software mix currently running on the STREAMbox. It embraces all those versions of software displayed subsequently.

Software Versions: The Software Information Table describes the versions of software used to build your STREAMbox. Not much use to you, but very useful to us in the event you need to contact us for further support.


Process Information:

These are the application processes currently active on the STREAMbox. Some processes stop and start as required during the scan/push cycles, so what you see here will vary each time you press the browser refresh button. Each of these lines is described below:


root 1249 1226 0 09:21 ttyp1 00:00:11 php cli-script.php app/scan

This is the master scan process and is started at boot time if there is a valid network available. You should always see this process because if there wasn't a valid network you wouldn't be able to see the Web Information Page.


root 1293 1 1 09:24 ttyp1 00:00:30 php cli-script.php app/push

This is the master push process which is started by the scan process when there are valid LIDs to be scanned. If you don't see this process and there are devices displayed in the Devices table, then we have a serious problem on the STREAMbox. Try restarting the STREAMbox and if it still isn't there when devices appear in the Devices table contact Splash Monitoring Support.


root 4621 1249 80 09:59 ttyp1 00:00:00 php cli-script.php app/update-device 1 2011-08-14 09:59:25

This is the scan process that has found valid data from one or more LIDs and is updating the local database. There will be one of these processes for each LID per scan cycle. These processes are usually very quick and because of the mechanics of the Web Information Page you will rarely see all of them together, but if you are persistent you will see them on subsequent refreshes.


root 4548 1293 48 09:58 ttyp1 00:00:00 php cli-script.php app/push-data http://us1.splashmonitoring.com/........./[FINGERPRINT] [Date & Time]

This is the push process that has found valid data in the local database and is pushing it to the Splash Monitoring web site. There will be one occurrence of this process per scan cycle and its duration will depend on the number of LIDs on your LAN and the speed of the internet connection. Again, you may or may not see this process but if you are persistent you should see it on subsequent refreshes.


root 4552 4426 0 09:58 ttyp2 00:00:00 ./si-steca si-steca-com1

If you have a serial interface defined then this is the process that gathers the information from those devices. The example here is showing Steca devices connected to COM port 1.





Diagnostics

Normal Operation:

Depending on the number of devices you have attached to the STREAMbox, the scan process can take several minutes to detect, recognise and 'push' data from these devices to the web site. Wait for at least 8 minutes after first powering up the STREAMbox before checking the web site for data. 8 minutes is how long it takes to do the initial scan on the default IP ranges (20 addresses), but if your scan range is much smaller, then the initial scan will be much quicker. However, you can begin your diagnostic checks before then if you want to watch the STREAMbox's progress.

The Devices table will eventually display a list of all the Devices the STREAMbox has detected. You can watch this data build up from STREAMbox startup by logging onto the Web Information Page as soon as possible and pressing the refresh button every 10 seconds or so. First you will see a list of the device addresses it finds, but with 'Unknown' in the Device Type column; then you'll see the device types appear in this column; then you'll see data appear in the Last Scanned and Last Pushed columns.

As described above the scan and push processes are separate but not independent, the push process will always follow the scan process. If everything is operating normally the timestamps for both sets of data will either be the same or within one scan cycle of each other and both within one scan cycle of the snapshot date and time at the head of the page. Note: because of the way the communication between the web page and core application works, you may have to refresh the page several times before the latest push and scan data are displayed.

The correct number of LIDs and TDs will be displayed in the Devices table.

The data for each TD will match or be very close to the realtime data displayed by the TD itself, depending on the scan cycle frequency and the rate of change of the data. Obviously if the data is changing rapidly on the TD then the data displayed on the information page will not be exactly the same, but it should be close enough to determine that the scan process at least is working properly.



Abnormal Operation:

Web Information Page doesn't display

If you can't get the STREAMbox Web Information Page to display on your web browser using the http://splash url, it is likely your router doesn't support this facility. In which case you will need to ascertain the IP address acquired by the STREAMbox from the DHCP server. There are several ways to achieve this, but the most definitive is to plug a screen into the VGA socket on the back of the STREAMbox, power cycle the STREAMbox and watch the boot sequence on the screen. At the end of the boot process you should be able to clearly see the DHCP allocated IP address. If you can't it is likely that there is no DHCP service visible to the STREAMbox, in which case check the LAN connectivity between the STREAMbox and the Network Access Device.

To do this you should plug a working PC into the same LAN cable you used for the STREAMbox and check that the PC can access the internet. This will tell you that the LAN connectivity is working but not necessarily that there is a DHCP service. There is no easy way to determine if your network supports DHCP, there are several utilities available on the web, but this is beyond the scope of this document and you should consult a network professional. However, it is very rare to encounter a network that doesn't support DHCP. All domestic NADs (routers, ADSL modems etc.) support DHCP and are always configured to provide this service by default. If yours appears not to, it may have been switched off by someone, in which case you should consult the device's user manual.

Once the STREAMbox has successfully acquired an IP address, as indicated by the boot sequence, you should also see a message 'Listening for connections...' at the end of the boot sequence. This indicates that the STREAMbox's web server process has started and is ready to service the Web Information Page. If this message doesn't appear it is usually indicative of LAN connectivity issues.

If you don't have a VGA screen to hand you could try guessing the STREAMbox's IP address by first ascertaining the DHCP allocated IP address of your LAN connected PC, then entering neighbouring IP addresses into the web browser until you encounter the STREAMbox's Web Information page. This works well on small (ie. domestic) networks, but would be very tedious on a large commercial network. However, on most commercial networks the STREAMbox may have been allocated a fixed IP address, which you should obtain from the network administrator. On a Windows PC you can ascertain its IP address by either clicking on 'settings/network', or going to the command prompt and issuing the 'ipconfig' command.

Now you can enter the STREAMbox's IP address into your web browser instead of the 'splash' url and you should get the Web Information Page displayed.

LAN Interface Devices Missing from Device Table:

As previously described it can take several minutes before data from recognised LIDs is available on the web site.

The STREAMbox can fail to detect LIDs on the LAN for many different reasons, here are the most frequent we encounter:

  1. The LID was incorrectly configured: Refer to the device configuration guide on the www.splashmonitoring.com/help web page.

  2. The physical LAN connectivity isn't working properly: Often the best way to check this is to attach a PC/laptop to the LID's LAN cable and see if you can get a connection to the internet or other intranet service.

  3. On a managed LAN the network management system is blocking communication between the STREAMbox and the LID: You will need to contact the network administrator to get them to allow HTTP trafic between the STREAMbox's IP address and each LID's IP address.

Serial Interface Devices Missing from Device Table:

PV Inverters often switch off when there is insufficient DC power and often they don't respond to data interrogation when in this state. Under these circumstances those devices should be automatically detected within 8 minutes or so of switching on, but you might want to check if 'missing' devices are switched on.

Other common reasons for failure:

  1. Incorrect connections: where a connector block is used rather than a plug (ie. SMA) then the cores may be connected to the wrong termials.

  2. Poor quality cable: where long cable runs are used you should use shielded twisted pair cable connected according to the manufacturer's specifications. This means the appropriate signals must be connected to the appropriate cores. Twisted pair cable works because interference is minimised by the twists themselves, provided the correct signals are attached to the appropriate pair.

  3. Untermiated bus: The last device on the bus should be terminated according to the manufacturer's specifications. However, in practice we have found on short cable runs termination can sometimes prevent communication. This may involve some trial and error.

  4. Incorrect device addressing: some devices need to have their bus address set on the device itself (ie Steca). See the manufacturer's instructions.

LAN Interface(s) displayed as 'Unknown' in the Device Type column:

This is usually because the scan process hasn't completed it's scan cycle, ensure you've given it chance to to recognise each device (up to 8 minutes). If it still displays as 'Unknown' then it is likely the device hasn't been configured correctly. Refer to the configuration documentation on the Splash Monitoring web site help pages.

Last Pushed timestamp is significantly behind Last Scanned timestamp:

This usually indicates there has been a disconnection with the internet or a connection was never established. This may have been a temporary outage, in which case you need to allow the push process some time to catch up. You can tell if this is the case because each time you push the refresh button the timestamp on the last pushed data will advance.

Sometimes the push process can't keep up with the scan process because of network instability or low grade connectivity. If you have a very 'slow' internet connection then you need to consider either increasing your bandwidth, or reducing the scan frequency. Reducing the scan frequency is described later.

A good way to check internet connectivity is to plug a PC/laptop into the same LAN cable used by the STREAMbox, get to the PC's command screen and enter 'ping us1.splashmonitoring.com' at the command prompt. If the connection is working properly you should see something like:

ping us1.splashmonitoring.com

64 bytes from 184-106-219-250.static.cloud-ips.com (184.106.219.250): icmp_req=1 ttl=46 time=217 ms

64 bytes from 184-106-219-250.static.cloud-ips.com (184.106.219.250): icmp_req=2 ttl=46 time=216 ms

64 bytes from 184-106-219-250.static.cloud-ips.com (184.106.219.250): icmp_req=3 ttl=46 time=217 ms

64 bytes from 184-106-219-250.static.cloud-ips.com (184.106.219.250): icmp_req=4 ttl=46 time=216 ms

64 bytes from 184-106-219-250.static.cloud-ips.com (184.106.219.250): icmp_req=5 ttl=46 time=222 ms

64 bytes from 184-106-219-250.static.cloud-ips.com (184.106.219.250): icmp_req=6 ttl=46 time=217 ms

64 bytes from 184-106-219-250.static.cloud-ips.com (184.106.219.250): icmp_req=7 ttl=46 time=222 ms

64 bytes from 184-106-219-250.static.cloud-ips.com (184.106.219.250): icmp_req=8 ttl=46 time=216 ms

64 bytes from 184-106-219-250.static.cloud-ips.com (184.106.219.250): icmp_req=9 ttl=46 time=217 ms

64 bytes from 184-106-219-250.static.cloud-ips.com (184.106.219.250): icmp_req=10 ttl=46 time=216 ms



--- us1.splashmonitoring.com ping statistics ---

10 packets transmitted, 10 received, 0% packet loss, time 9008ms

rtt min/avg/max/mdev = 216.236/218.152/222.952/2.404 ms



If you get something like:

ping us1.splashmonitoring.com

From dsldevice.lan (192.168.1.254) icmp_seq=1 Destination Host Unreachable

From dsldevice.lan (192.168.1.254) icmp_seq=2 Destination Host Unreachable

From dsldevice.lan (192.168.1.254) icmp_seq=3 Destination Host Unreachable

From dsldevice.lan (192.168.1.254) icmp_seq=4 Destination Host Unreachable

From dsldevice.lan (192.168.1.254) icmp_seq=5 Destination Host Unreachable

From dsldevice.lan (192.168.1.254) icmp_seq=6 Destination Host Unreachable

From dsldevice.lan (192.168.1.254) icmp_seq=7 Destination Host Unreachable

From dsldevice.lan (192.168.1.254) icmp_seq=8 Destination Host Unreachable



--- us1.splashmonitoring.com ping statistics ---

9 packets transmitted, 0 received, +8 errors, 100% packet loss, time 8015ms



It is likely that you are not allowed through your network's firewall onto the internet, in which case you'll need to contact your network administrator to get access. Network administrators need to know that the STREABbox uses HTTP port 80 to communicate with both us1.splashmonitoring.com and sus.splashmonitoring.com

Ideally the turnaround time('time' in the above example) should be less than 1000 miliseconds and a very similar number for each ping, and the number of packets lost should be 0. Long turnaround times are indicative of a slow internet connection. Sometimes the cabling between the PC and the Network Access Device (NAD) is faulty or the port on the NAD itself is faulty. You should eliminate faulty cabling by plugging your PC directly into the NAD using a known good CAT5 or CAT6 cable. You should also try the same exercise on different ports on your NAD to eliminate them.

Lost packets are indicative of an unstable internet connection and you need to get it investigated by a network professional.



Changing the STREAMbox's Settings

Changing the STREAMbox's settings will significantly alter its behaviour, getting it wrong could render it inoperable. Please take the time to read and understand all the information in this document, which is also available on the www.splashmonitoring.com/help pages.

At the bottom of the Web Information Page is a button labeled 'Change Settings', click on this and change settings page will be displayed.

Read the guidelines set out on the web page and make your changes by clicking on the relevant boxes and changing the values.

We make no checks on the validity of any network settings beyond those stated on the web page, so the onus is on you to know what you're doing. For example, if you change the IP addresses on eth0 and eth0:1 to ones that your PC can't 'see' you will not be able to reconnect to the STREAMbox until you've reconfigured your PC's LAN interface.

When you've completed your changes click on the 'Submit Changes' button and the submit changes page will be displayed.

If you have selected something that violates the Guidelines it will be displayed in red and only the 'Back' button will be displayed. Click 'Back' and change your selection accordingly.

If you (and we) are happy with the settings click the 'Accept' button. This will save the settings and restart the appropriate applications. You can also choose to reboot the STREAMbox at this point by selecting the relevant radio button. If you do, it will take several minutes to complete, during which time the STREAMbox will be out of service and inaccessible.

If the STREAMbox fails to respond after several minutes (give it 10 minutes to be certain) and you are convinced you have correctly configured your PC to 'see' the STREAMbox you can use the following procedure to recover it:



Recovering the STREAMbox using a USB memory stick

It's possible to reset some of the STREAMbox's configuration parameters by following the procedure below. However, there is no error checking, so you need to fully understand what you're doing by understanding the principles set out above and following these instructions very carefully. The consequence of not doing this is to risk total malfunction of the STREAMbox.

  1. Power down the STREAMbox and insert a VFAT formatted USB memory stick in the USB port on the back of the STREAMbox. The stick does not have to be empty.

  2. Power up the STREAMbox and either watch the boot sequence on a VGA screen as described earlier, or wait 10 minutes.

  3. Remove the USB memory stick and mount it on your PC.

  4. On the USB stick there should be a directory called 'streambox-files' containing at least two configuration files: SMuser.ini and rc.inet1.conf. Depending on whether the STREAMbox has been successfully running in the past there may also be others: 'SM.devices'; 'resolv.conf'; and several 'healthcheck.log' files.

  5. For now we're going to focus on SMuser.ini

  6. Edit SMuser.ini on the USB memory stick using your favourite plain text editor. It doesn't matter whether this is a DOS, MS/Windows or Linux utility so long as it leaves a plain text file on the USB stick.

  7. In this file you can change the scan cycle by changing the number between the quotes: scan_frequency = “10”. 10 seconds is the highest alowable frequency, some devices such as the Sunny WebBox can't be scanned at a frequency of less than 30 seconds. If you need to change this value because you have a slow or expensive (3G) internet connection, you must choose one of the following values: 30, 60, 300 and 900 seconds. You must also set the scan frequency defined in the Fingerprint tab on the Splash Monitoring dashboard to match your chosen value, if you don't the reporting tools on the web site are likely to give you unpredictable results.

  8. The format of this file is very strict: don't alter the parameter name; there must be one space each side of the '=' sign; the value between the quotes is critical, so if you type 3O instead of 30 it will have an unpredictable and almost certainly detrimental effect. Mistakes in this file will cause the STREAMbox to behave unpredictably or fail completely.

  9. Insert the 'edited' stick back into the STREAMbox and power cycle it. This will copy the edited config file(s) off the stick into the live directories, thus modifying the behaviour of the STREAMbox. Once the reboot cycle is complete you can remove the USB stick, it is no longer needed unless you want to make further changes.

Changing The Scan Range

  1. Follow the same procedure detailed above but edit the 'scan_ip_first' and 'scan_ip_last' IP addresses.

  2. Please note these should be on the same network range as your DHCP server unless you change the static IP address of the STREAMbox itself – see below.

  3. The wider this range the longer the STREAMbox will take to perform its initial scan. This is not a problem, but you may want to keep this range as short as possible. Setting the first and last to the same address will scan only that address.

Changing The Rescan Cycle

  1. The defalt rescan cycle is set at once per day or 86,400. Use the same procedure as above if you need to change this.

  2. Please bear in mind that the rescan cycle interrupts the normal scan cycle and the disruption period depends on how many LIDs you have attached to the LAN and the range of IP addresses it is set to scan. Clearly if this cycle is too short you will impede the normal operation of the STREAMbox. We make no checks on this setting.

Changing Network Addressing Parameters.

  1. Similarly to the above procedure, you can edit the 'rc.inet1.conf' file on the USB memory stick, but you really need to understand what you're doing or you risk making the STREAMbox totally inoperable. For this reason you should make a copy of 'rc.inet1.conf' before you start editing it.

  2. The default format of the file is as follows:

IFNAME[0]="eth0"

IPADDR[0]=""

NETMASK[0]=""

USE_DHCP[0]="yes"

DHCP_HOSTNAME[0]=""


IFNAME[1]=""

IPADDR[1]=""

NETMASK[1]=""

USE_DHCP[1]=""

DHCP_HOSTNAME[1]=""


GATEWAY=""


  1. It is important you maintain this format with no spaces between the parameter name and the '=' sign, and the values must be between the double quotes “”.

  2. The values themselves are of course critical so if you don't understand IP networks please seek the advice of someone who does.

  3. If you need to assign a static IP address to the STREAMbox please do so at IPADDR[0] and set USE_DHCP[0]=”no”.

  4. If you have to change the IP address of the scan range please assign a new static IP address at IPADDR[1] in the same network as the new scan range.

  5. NOTE: IPADDR[0] and IPADDR[1] can not have the same static IP address, so if you need to make the STREAMbox static and have it scan for LIDs on the same network range, assign a static IP address at IPADDR[0], set USE_DHCP[0]=”no”, set IPADDR[1]=””, NETMASK[1]=””, USE_DHCP[1]=”” and DHCP_HOSTNAME=””.

  6. If you make a mistake you can restore the copy of 'rc.inet1.conf' or re-edit it and reboot the STREAMbox with the edited version installed in the 'streambox-files' directory of the USB memory stick.

In Summary:

If you boot the STREAMbox with a blank USB memory stick inserted, the current versions of the configuration files will be dumped to a directory called 'streambox-files' on the stick.

If you boot the STREAMbox with a USB stick installed and any of the configuration files are installed in the 'streambox-files' directory of the stick, those configuration files will override their corresponding live configuration files on the STREAMbox.

If you boot the STREAMbox with a USB stick installed and the 'streambox-files' directory contains a file named SM.reset this will delete all user selected settings and return them to factory defaults. This file doesn't have to contain anything, just the fact that it exists on the USB stick is sufficient. Its existence overrides the presence of any of the configuration files described above.

If you boot the STREAMbox with a USB stick installed and the 'streambox-files' directory contains a file named 'SM.factory-defaults' this will delete all uploaded software updates and user selected settings and return them to factory defaults. This file doesn't have to contain anything, just the fact that it exists on the USB stick is sufficient. Its existence overrides the presence of any of the configuration files described above. This facility is provided as a last resort when all other attempts to restore the STREAMbox have failed.





Dumping raw data to USB memory

As discussed earlier, the push process may occasionally lose its connection to the web site, but the scan process should continue to collect data from each TD if the local LAN is still operational. Very occasionally the push process may fail to reestablish its connection to the web site and the STREAMbox needs to be rebooted. In this event all collected data will be lost. However, before rebooting the STREAMbox, you can dump this data to a USB memory stick.

Simply insert a USB memory stick into the USB slot on the back of the STREAMbox and from the Web Information Page select the 'Dump data to USB' button.

The USB stick needs to be formatted as a vfat (windows) filesystem. It does not need to be empty, but have sufficient space to accommodate the data.

A file 'SMdata.csv' will be created, if it already exists it will be over-written, so if you execute this procedure more than once don't forget to rename or move the file.

SMdata.csv is a CSV file intended to be read using a spreadsheet. Each line of data within has the following meaning:

Column A: Telemetry Device number. You should sort the spreadsheet by column A to gather all the data for each TD together.

Column B: is the timestamp the data was collected. You should sort the spreadsheed by column B after column A. This is not strictly necessary as the data is already sorted by timestamp.

Column C onwards: These are the raw data numbers for each of the sensors attached to this TD. They correspond to the lable positions in the 'Labels' button on the Splash Monitoring web site Dashboard.

You can execute this process as many times as you like, the data will remain in the local database until the STREAMbox is rebooted.

If you execute this procedure during normal operation the SMdata.csv file is likely to be either empty or contain partial data for a single scan. This is because the data in the local database is deleted by the push process upon successfully pushing it to the web site.



Healthcheck

This will run a number of checks on the STREAMbox to test its configuration and review the error logs. You will be asked how many TDs are physically connected to the LAN so we can check whether all these devices have been detected.

Depending on the number of devices connected and the state of the LAN connections, the checks will take several minutes before the report appears, so please bear with us. The report will tell you what has been checked and the result. If we think you need to take some action then the recommended action will be highlighted in red.



Update Software

By 'software' we mean all those packages mentioned in the Software Information Table of the Web Information Page.

Updating the software is a fairly complex and therefore potentially risky business. Therefore you need to have a compelling reason to update the STREAMbox. There is no need or point to update a STREAMbox that is working properly. Valid reasons for updating the software are usually because you need to add a new device type that the current version of software doesn't recognise, or because the current version never worked properly. If a STREAMbox that was working properly suddenly stops then it is more than likely the problem is elsewhere and updating the software may exacerbate rather than solve the problem. Under these circumstance it is far better to identify the cause of the problem and fix it rather than trying to update the software.

As a result, we will only authorise software updates upon request, and the request must be based on a reasonable and rational requirement. To request a software update please go to the Splash Monitoring web site and select 'Contact'. Fill out the form (don't worry about the tick boxes) but please include your fingerprint and reason for needing an update.

When the request for an update has been has been approved you can then either come to the Web Information Page and request a download, or you can power cycle the STREAMbox and it will check for authorised updates automatically during the boot sequence.

When you request a download the system will check to see if: a) the Software Update Service is available; b) whether your fingerprint has been authorised to take an update; c) there is a more recent update available than the one already on your STREAMbox. If these conditions are met the update process will be started.

For any one particular 'Release' the package versions must match a defined list for that release. Not all packages will change between releases, for example the Linux kernel has never changed, but sometimes a change in one package is dependent on a change in another, so both packages must be downloaded in order to achieve a successful update. To minimise network traffic and the time taken to perform the update, we only download those packages that have changed. The RAMdisk and the kernel are relatively large files, but fortunately rarely change, whilst the application packages are relatively small and it these that are more likely to change.



Restore Previous Release

Following a successful software update we store the previous release plus the release the STREAMbox left the factory with (Factory Default). In the event of a software update failure the system will attempt to restore itself back to the previous release if it exists and it is sound. However, you may also choose to restore the previous release if you think there is a fault in the current release. Please be aware that if you do restore the previous release you will also restore the settings that prevailed at the time the current release was installed, so if they have changed since then you will have to modify them accordingly.



Restore Factory Defaults

As described above, in the event of a software update failure the system will attempt to restore itself back to the previous release if it exists and it is sound. However, if it fails to restore a sound previous version it will restore the Factory Defaults (see above). You may also choose to restore the factory defaults if you think there is a fault in the current release. Please be aware that if you do restore the factory defaults you will also restore factory default settings wich may be very different from your current settings, so this option must be used with extreme caution.



Force a Rescan

If the scan process has failed to pick up a device at startup, of if you have added a new device, you can force the STREAMbox to rescan all the IP addresses in the scan range. Whilst this will not affect currently known devices, it will potentially take some time to complete, depending on how wide your scan range is set. Performing a rescan will interrupt the regular scan cycle for the duration of the rescan, so it is imortant to minimise the number of rescans performed, and also to optimise the scan range according to the number of LIDs attached to the network.

If you add a new device and have to widen the scan range to accommodate it, the new device should be picked up as a result of the resart that will have to be done following the change to the scan range. If the new device is not detected, then after checking the device you can force a rescan here without needing a reboot.

Copyright Splash Monitoring all rights reserved