5,838
edits
Category:Cumulus MX: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
→Setting up for either manual or automatic running
| (17 intermediate revisions by the same user not shown) | |||
| Line 60: | Line 60: | ||
The [[Cumulus MX FAQ]] page is (as I type this) being updated to answer a lot of the questions you might have. | The [[Cumulus MX FAQ]] page is (as I type this) being updated to answer a lot of the questions you might have. | ||
If that does not help | If that does not help... | ||
<big>If your question relates do an ongoing problem with using MX, then please follow these instructions, don't just post "Help me":</big> | <big>If your question relates do an ongoing problem with using MX, then please follow these instructions, don't just post "Help me":</big> | ||
| Line 69: | Line 69: | ||
#) zip the latest file updated in '''CumulusMX/MXDiags''' folder. Add into zip, any log files that seem relevant to your question, and any other files you have modified from their content in the MX distribution if those files are relevant to your problem. | #) zip the latest file updated in '''CumulusMX/MXDiags''' folder. Add into zip, any log files that seem relevant to your question, and any other files you have modified from their content in the MX distribution if those files are relevant to your problem. | ||
#) At this point you can optionally try restarting MX | #) At this point you can optionally try restarting MX | ||
#) Now ask your question in the correct sub-forum [https://cumulus.hosiene.co.uk/viewforum.php?f=40 Cumulus MX Current (releases since b3043)] | |||
#) Use the attachment tab below the posting window to upload your zip. In the post explain your problem, and quote any settings (do not disclose passwords) that might be relevant. Also state what device you are running MX on, and on what device you view the admin interface. | #) Use the attachment tab below the posting window to upload your zip. In the post explain your problem, and quote any settings (do not disclose passwords) that might be relevant. Also state what device you are running MX on, and on what device you view the admin interface. | ||
#If your problem relates to uploading, some information on your web server structure can help. | #) If your problem relates to uploading, some information on your web server structure can help. | ||
#If your problem relates to the admin interface say so. | #) If your problem relates to the admin interface say so. | ||
#If your problem relates to web pages on your own web server (not server generated for the admin interface) say so, and which web pages you are using, and (if relevant) PHP version being used. | #) If your problem relates to web pages on your own web server (not server generated for the admin interface) say so, and which web pages you are using, and (if relevant) PHP version being used. | ||
#Given the right information, as listed above, | #) Given the right information, as listed above, permits other people to answer your question easily. | ||
If your question does not directly relate to using MX, then there are other sub-forums available at [https://cumulus.hosiene.co.uk/index.php Cumulus Support Forum] where you can post your question giving relevant supporting information, that might include a link to a web page relating to your problem. | |||
== Comparing Cumulus 1 and MX == | == Comparing Cumulus 1 and MX == | ||
| Line 132: | Line 135: | ||
=== Accessing Admin Interface === | === Accessing Admin Interface === | ||
Cumulus 1 was an all in one application, it both read the data from the weather station and provided the user interface for you to see the derived data and change the settings. MX is different, it consists of a stand-alone 'engine' which performs the reading and logging of data, uploading to a web site etc. This 'engine' is a command-line/console application which has no user interface. The separate admin interface is provided by virtue of the engine acting as a web server. | Cumulus 1 was an all in one application, it both read the data from the weather station and provided the user interface for you to see the derived data and change the settings. MX is different, it consists of a stand-alone 'engine' which performs the reading and logging of data, uploading to a web site etc. This 'engine' is a command-line/terminal/console application which has no user interface. The separate admin interface is provided by virtue of the engine acting as a web server. | ||
When you successfully start MX, the engine is running until it is terminated. You can view the admin interface by typing the URL of the built-in web server into your browser, either on the same machine, or on a separate machine sharing the same local network. The default URL ''if the browser is on the same machine as MX'' is '''http://localhost:8998/'''. | When you successfully start MX, the engine is running until it is terminated. You can view the admin interface by typing the URL of the built-in web server into your browser, either on the same machine, or on a separate machine sharing the same local network. The default URL ''if the browser is on the same machine as MX'' is '''http://localhost:8998/'''. | ||
| Line 221: | Line 224: | ||
Look at your hub or router (this should have come with instructions on how to do this in your browser) and on one screen it should show what devices are connected to your LAN and wifi. Look for the IPv4 address (w.x.y.z) of the device you have installed MX on, for example 192.168.1.64. Then give your Computer a fixed address for MX user interface by finding the network card via Network and Sharing Centre (Control Panel), click on Change Adapter Settings, then Right click on Ethernet or WiFi Adapter, select Properties and in the window that opens right click on Internet Protocol Version 4 (TCP/IP 4), and select properties and on that pop up screen tell the computer to "use the following IP address and fill it out with a subnet mask of 255.255.255.0 and gateway address between 192.168.1.1 and 192.168.1.254 (depending on the address of your hub/router). | Look at your hub or router (this should have come with instructions on how to do this in your browser) and on one screen it should show what devices are connected to your LAN and wifi. Look for the IPv4 address (w.x.y.z) of the device you have installed MX on, for example 192.168.1.64. Then give your Computer a fixed address for MX user interface by finding the network card via Network and Sharing Centre (Control Panel), click on Change Adapter Settings, then Right click on Ethernet or WiFi Adapter, select Properties and in the window that opens right click on Internet Protocol Version 4 (TCP/IP 4), and select properties and on that pop up screen tell the computer to "use the following IP address and fill it out with a subnet mask of 255.255.255.0 and gateway address between 192.168.1.1 and 192.168.1.254 (depending on the address of your hub/router). | ||
==== Setting up for either manual or automatic running ==== | |||
There are 3 ways on Windows to create a way to run MX | |||
#Create a shortcut on your desktop (and/or the taskbar) for the '''CumulusMX.exe''' executable | |||
#*In that shortcut define the path where the executable is located as the path to start in. | |||
#* '''Remember, if you have not done the <tt>''netsh http add urlacl url=http://*:8998/ user=\users''</tt> command mentioned above, you must run as administrator.''' | |||
#* Add any of the parameters that can be used with the executable, as listed later, such as specifying a different port for the admin interface , or starting with debugging. | |||
#*Choose whether to start as minimised or as a command window | |||
#*You can also choose text colour (foreground) and background colour, you can choose where the window appears (so if you have two monitors you can choose which one it appears on), and how big that window is. There is a forum post by water01 about this. | |||
#*Now you can click the shortcut to start the engine | |||
#OR place the shortcut as defined above in the start up folder for the user account so MX automatically starts when you connect/log in (see a later section for how to find that start up folder). | |||
# OR declare a task in the scheduler to start MX; in the '''Actions''' tab fill in fields as follows (the other tabs should be obvious): | |||
#**'''Action''' <tt>Start a program</tt> from drop-down | |||
#**'''Program/script''' <tt>cmd.exe</tt> | |||
#**'''Add arguments''' <tt>/C start "Start_MX" "\CumulusMX\CumulusMX.exe"</tt> (the "/C" means this task will close once it has started the task, the "Start_MX" is how the task will be labelled as it is running, the next argument actually starts the executable and it does not need a drive prefix as that is in next box. | |||
#**(there are some optional parameters that can be used after the .exe call in that same box, such as a '''port=nnn''' where nnn is the port to be used for admin interface, all optional parameters are listed later) | |||
#**'''Start in''' <tt>\CumulusMX</tt> (include a drive specifier if necessary) | |||
==== Each time you want to run Cumulus MX on Windows: ==== | ==== Each time you want to run Cumulus MX on Windows: ==== | ||
#First '''start the engine''' in one of the | #First '''start the engine''' in one of the 3 ways from last sub-section | ||
# Next '''start the admin interface''', it does not need to run all the time, but only when you need it (when you first use MX you will need it to access the settings where you tell MX what type of station you have and what units you want to use, and set various timing options), it normally runs on port 8998 (to vary that there is a '''-port''' parameter that is followed by required port and that port parameter has to be entered every time you start MX if you are not using the default port). | # Next '''start the admin interface''', it does not need to run all the time, but only when you need it (when you first use MX you will need it to access the settings where you tell MX what type of station you have and what units you want to use, and set various timing options), it normally runs on port 8998 (to vary that there is a '''-port''' parameter that is followed by required port and that port parameter has to be entered every time you start MX if you are not using the default port). | ||
| Line 627: | Line 643: | ||
= Updating to a new MX release = | = Updating to a new MX release = | ||
If you have a monitor to see the output from the Cumulus MX engine (Windows call this a console window, Unix-based implementations call this the output terminal window), ''' | == MX output message === | ||
If ... | |||
#...you have a monitor to see the output from the Cumulus MX engine (Windows call this a console window, Unix-based implementations call this the output terminal window), | |||
#..'''your device running MX is connected to internet''', AND | |||
#...you restart MX | |||
... then you will see a prompt when a new version is available. Equally if you can view the MXdiags file for the current session of MX that is running with connection to the internet, that will say if a new version of MX is available. | |||
There is no message in either place ... | |||
*... if you are using latest version, | |||
* ... if you are not connected to the internet, OR | |||
* you do not restart MX! | |||
== What to read before updating == | |||
*If your update is from the immediately previous build, then just check the release announcement in the support forum, or the précis style entry at [[Cumulus_MX_formal_release_versions]] in this wiki (if that is up to date) for which files have been affected. The actual release announcement will be more informative telling you if the upgrade requires one-off actions (like changing the schema if you use a database, or editing your web pages to take advantage of new web tags). The release announcement may sometimes include scripts to download and run to perform one-off actions. | *If your update is from the immediately previous build, then just check the release announcement in the support forum, or the précis style entry at [[Cumulus_MX_formal_release_versions]] in this wiki (if that is up to date) for which files have been affected. The actual release announcement will be more informative telling you if the upgrade requires one-off actions (like changing the schema if you use a database, or editing your web pages to take advantage of new web tags). The release announcement may sometimes include scripts to download and run to perform one-off actions. | ||
*If your update is skipping some intermediate versions, then check the corresponding release announcements or Wiki entries for every version since the one you have been using before planning your upgrade. Again there may be one-off actions required at particular in-between versions. | *If your update is skipping some intermediate versions, then check the corresponding release announcements or Wiki entries for every version since the one you have been using before planning your upgrade. Again there may be one-off actions required at particular in-between versions. | ||
== Back-ups == | |||
== two approaches == | It is always best to take a backup of your existing MX installation before you do an update, this allows you to regress back to the earlier version if either you mess up installing the new version, or the new version has a issue that prevents it working with the versions of other software (like MONO) that your installation uses. | ||
== The two approaches == | |||
Some people upgrade by just copying in the files that the release announcement says have changed, others copy in all files from the downloaded zip. The first should only be used with caution, files like '''CumulusMX.exe.config''' can change between versions, but not be mentioned in a release announcement, and the developer will have been making edits to files since the previous release, and might forget exactly which files have been edited between releases. Also you may be upgrading from an earlier version and therefore be skipping several intermediate releases. You may be able to see the dates when files were changed within the zip and therefore be able to decide for yourself if you compare those dates with the previous release you were using if you have kept the download for the version you were using. | Some people upgrade by just copying in the files that the release announcement says have changed, others copy in all files from the downloaded zip. The first should only be used with caution, files like '''CumulusMX.exe.config''' can change between versions, but not be mentioned in a release announcement, and the developer will have been making edits to files since the previous release, and might forget exactly which files have been edited between releases. Also you may be upgrading from an earlier version and therefore be skipping several intermediate releases. You may be able to see the dates when files were changed within the zip and therefore be able to decide for yourself if you compare those dates with the previous release you were using if you have kept the download for the version you were using. | ||
| Line 643: | Line 675: | ||
#*then David [https://cumulus.hosiene.co.uk/viewtopic.php?p=140355#p140355 (see this post)] recommends this different approach. After downloading a new release unzip it on the device/disc where you down load it. Next simply copy the files (optionally only those that have newer dates because they have changed) into the existing MX directory on the device where you run MX. Then you know all your existing files are there, and as mentioned you can choose to only copy in the minimum number of files as specified in the release notes (find them on [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 this forum] or in [[Cumulus_MX_formal_release_versions|Wiki here]]). | #*then David [https://cumulus.hosiene.co.uk/viewtopic.php?p=140355#p140355 (see this post)] recommends this different approach. After downloading a new release unzip it on the device/disc where you down load it. Next simply copy the files (optionally only those that have newer dates because they have changed) into the existing MX directory on the device where you run MX. Then you know all your existing files are there, and as mentioned you can choose to only copy in the minimum number of files as specified in the release notes (find them on [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 this forum] or in [[Cumulus_MX_formal_release_versions|Wiki here]]). | ||
== Updating when files within release might overwrite your edits == | == Updating when files within release might overwrite your own edits == | ||
If you have edited any files, see if the release notice says that file has been revised, if it has not then it is easy to keep your edited file by not copying in the replacement file from within the zip. If the release revises any file you previously edited, take a backup of your edited file, before you copy the new file into your folder. You can then use a file comparing tool to see what has changed in the release and what you changed and hopefully manage to merge to a new file that keeps any functionality change in a new release and keeps your customisation. | If you have edited any files, see if the release notice says that file has been revised, if it has not then it is easy to keep your edited file by not copying in the replacement file from within the zip. If the release revises any file you previously edited, take a backup of your edited file, before you copy the new file into your folder. You can then use a file comparing tool to see what has changed in the release and what you changed and hopefully manage to merge to a new file that keeps any functionality change in a new release and keeps your customisation. | ||
| Line 651: | Line 684: | ||
== After update == | == After update == | ||
Start the new installation of MX and watch out for any errors - If the device you run MX on has a monitor, then look in the terminal/command window. In all cases look at the latest file in the MXdiags folder to see if any errors are reported. | Start the new installation of MX and watch out for any errors - If the device you run MX on has a monitor, then look in the terminal/command window. In all cases look at the latest file in the MXdiags folder to see if any errors are reported. | ||
| Line 710: | Line 744: | ||
The '''Data logs''' tab in the admin interface a shown right gives access to screens that can display the contents of [[Monthly log files|Detailed log files for any month]] with menu item '''Data logs''' (yes same name as tab), the [[Extra Sensor Files|Extra Sensor Log Files]] with menu item '''Extra Data Logs''', and the [[Dayfile.txt|daily summary log (dayfile.txt)]] with menu item '''Dayfile'''. | The '''Data logs''' tab in the admin interface a shown right gives access to screens that can display the contents of [[Monthly log files|Detailed log files for any month]] with menu item '''Data logs''' (yes same name as tab), the [[Extra Sensor Files|Extra Sensor Log Files]] with menu item '''Extra Data Logs''', and the [[Dayfile.txt|daily summary log (dayfile.txt)]] with menu item '''Dayfile'''. | ||
All screens use datatables, and the schema used is based on that defined in the version of MX you are running. | All screens use the datatables library to access the application programme interface (api) representing the selected log file, and the schema used is based on that defined in the version of MX you are running. | ||
Version 3.6.1 changes the wording on the pop up dialogs showing a single row; Earlier versions used "Close", "Edit" buttons. Later versions use the more meaningful "Cancel" and "Save" buttons respectively. The new terminology takes precedence in the following sub-sections. | |||
<big>WARNING: In any of these editors, when you save a row that was shorter because it was created by an earlier version, datatables will store the row with the length defined in the MX version you are using, so extra commas (and any values you set) will be added to end of just any line that has been edited, leaving other lines unchanged in length.</big> | <big>WARNING: In any of these editors, when you save a row that was shorter because it was created by an earlier version, datatables will store the row with the length defined in the MX version you are using, so extra commas (and any values you set) will be added to end of just any line that has been edited, leaving other lines unchanged in length.</big> | ||
(Aside: The "Success" message (with all possible alternatives) is defined in <tt>CumulusMX\interface\lib\datatableseditor\dataTables.altEditor.free.js</tt>, as this is definitely loaded for these screens, it is possible you can edit that script to make messages like "Success" appear in a different language). | |||
=== Data logs === | === Data logs === | ||
This screen can be used to display any monthly log file in the '''CumulusMX/data''' folder. None are displayed until you select date (defaults to current month) and click '''Load'''. The selector will find any file in the folder, including those those for dates before when MX believes is earliest date (StartDate= xxxx, in Cumulus.ini). The only proviso is that the file naming must obey that currently defined in the current locale supplied to MONO (or defined in Control Panel for Windows operating system). Obviously, if you choose to load the default (the current) log file, what you see loaded is how the file | This screen can be used to display any monthly log file in the '''CumulusMX/data''' folder. None are displayed until you select date (defaults to current month) and click '''Load'''. The selector will find any file in the folder, including those those for dates before when MX believes is earliest date (StartDate= xxxx, in Cumulus.ini). The only proviso is that the file naming must obey that currently defined in the current locale supplied to MONO (or defined in Control Panel for Windows operating system). Obviously, if you choose to load the default (the current) log file, what you see loaded from the api mentioned above is how the file was at time of creating that api, more lines may be appended to the file while the screen is open, but as far as I can tell the contents shown are not refreshed, so you can only edit those available at time of load. | ||
Highlight any one row and the ''datatables'' software used here will offer '''Edit''' and '''Delete''' buttons that operate on that row. The Edit button pops up a dialog showing all fields available in the version of MX you are using. If the log file has fewer fields because it was created by an earlier version of Cumulus, the excess fields will not show any value. Make any edits, click the '''Save'''(prior to MX version 3.6.1, it was "Edit") button and hopefully you will see a ''Success'' message. | |||
=== Extra Data Logs === | === Extra Data Logs === | ||
| Line 730: | Line 767: | ||
For displaying and editing the dayfile.txt file. Like the others, highlight any one row and the ''datatables'' software used here will offer '''Edit''' and '''Delete''' buttons that operate on that row. | For displaying and editing the dayfile.txt file. Like the others, highlight any one row and the ''datatables'' software used here will offer '''Edit''' and '''Delete''' buttons that operate on that row. | ||
Please don't use this option either when MX has only just started, or within 10 minutes either side of your rollover time, because in both cases MX needs exclusive access to the file | Please don't start to use this option either when MX has only just started, or within 10 minutes either side of your rollover time, because in both cases MX needs exclusive access to the file. Since the file being edited is provided via an api (see above) I don't believe its use by the datatables software ''could'' cause a conflict, but let us play safe. | ||
Note, when you click the Edit button, it pops up a window that shows all the fields (in the highlighted row) vertically with cancel and save buttons visible when you scroll down. It does not show any values from any other files. MX does not provide within this screen any way to read the monthly data logs for a particular day and recalculate the value to place in any field of this dayfile log. In the future it is possible that there might be a separate executable, outside the admin interface that could do this (similar to separate executable mentioned for MySQL functionality, later on this page), but at the time of writing that is no more than a possible very low priority project. | Note, when you click the Edit (table) button, it pops up a window that shows all the fields (in the highlighted row) vertically with cancel (previously "close") and save (previously "edit" or "edit row") buttons visible when you scroll down. It does not show any values from any other files. MX does not provide within this screen any way to read the monthly data logs for a particular day and recalculate the value to place in any field of this dayfile log. In the future it is possible that there might be a separate executable, outside the admin interface that could do this (similar to separate executable mentioned for MySQL functionality, later on this page), but at the time of writing that is no more than a possible very low priority project with the developer. | ||
== Changing Settings == | == Changing Settings == | ||
| Line 746: | Line 783: | ||
'''Note that if you change settings''', that '''some''' settings do not take effect while MX is running, while other settings do take effect instantly (I have not found a definitive list anywhere) - anyway, you ''may'' need to restart Cumulus MX to get the new setting picked up. When you exit MX, it saves the settings in [[Cumulus.ini]], and when you restart it it uses the settings it reads from that file. | '''Note that if you change settings''', that '''some''' settings do not take effect while MX is running, while other settings do take effect instantly (I have not found a definitive list anywhere) - anyway, you ''may'' need to restart Cumulus MX to get the new setting picked up. When you exit MX, it saves the settings in [[Cumulus.ini]], and when you restart it it uses the settings it reads from that file. | ||
(Aside: The "Success" message (with all possible alternatives) is defined in <tt>CumulusMX\interface\lib\datatableseditor\dataTables.altEditor.free.js</tt>, I am unsure whether this is used with the settings pages, but it is possible you can edit that script to make messages like "Success" appear in a different language). | |||
=== Station Settings === | === Station Settings === | ||
