External Extra Sensors and Default Website Development: Difference between pages

From Cumulus Wiki
(Difference between pages)
Jump to navigationJump to search
 
 
Line 1: Line 1:
==The default CMX website Development==
== Introduction ==
{|align=right
|__TOC__
|}
Sensors which the user has available but which are not logged by CumulusMX, CumulusUtils has an option available to integrate these sensors with the standard CMX sensors and plot them in whatever combination you want. As an example I use [https://cumulus.hosiene.co.uk/viewtopic.php?t=20242 the Geiger Counter] which caused this addition to be implemented.


These section of the Wiki will enable you to get the latest information and resources for the alternative to the default CumulusMX public website.
== Operation ==
#All conditions for the [[Extra Sensors]] module must be met.
#CumulusUtils must be run once with the command ''ExtraSensors'' or ''Website'' to create the required parameter in the section ''[ExtraSensors]'' in the inifile.
#Set the name (or names) for External Extra Sensor in the parameter ''ExternalExtraSensors'' in the section ExtraSensors in ''cumulusutils.ini'' (e.g. ExternalExtraSensors=GeigerCounter).
#Make sure you have a datafile(s) available in the data directory of CMX with the following name: ''<sensor name>yyyyMM'' e.g. ''GeigerCounter202203.txt''
#Make sure you run ''UserAskedData'' to make sure the External Sensor Data are available for the website in the known JSON format.


===Alternative public website===
The datafile(s) have the following plain text format:
Please note. This is NOT part of the CumulusMX Distribution package and is provided only for those interested in having a public site that uses similar structures to the Alternative Interface.
datetime,value
(datetime format: ''dd/MM/yy, HH:mm'', value format: ''double'' with point as decimal separator)


Although it should function at the date of release, no guarantees are given that it will continue to do so with subsequent releases of CumulusMX. Users should take time to investigate how it reacts and uses the library and data files uploaded by CumulusMX so that you are able to do some troubleshooting for yourself.
== Output ==
The output is completely integrated in the Extra Sensor module and can not be separated from it.


Full details of the alternative public website, including screenshots can be fond on [https://oaktreewebs.co.uk/wiki/ my wiki] together with comprehensive instructions on how to install, use and modify.
== Inifile Parameters ==
The ''External Extra Sensor'' module has the following inifile parameter (see [[cumulusutils.ini]]):


This site also comes with new themes (unfortunately not compatible with the AI or previous versions) that should be easier to modify for your own needs.
[ExtraSensors]
See [[Extra Sensors]]
ExternalExtraSensors=GeigerCounter[, sensor2 [,sensor3]] => A comma separated list of strings naming one or more External Extra Sensors the user wishes to use


'''Download the [https://www.cumuluswiki.org/images/0/08/PublicWebsite.zip latest version here]''' (Updated: (14:30 29th July 2025) '''W3C Validated code'''.)
== Inner Working ==
When all conditions for the Extra Sensors are met and an External sensor is defined, the External Sensor is added to the internal lists of both the [[Extra Sensors]] as the [[ChartsCompiler]] and the internal datastructures of the fixed names as defined in CDL are expanded. When using the plotvariable for the external sensor the same name is used as in the definition in the inifile. So for ''ExternalExtraSensors=GeigerCounter'', the user would e.g. see a chart definition appear (when the automatic mode is selected) as follows:


====Amendments since last revision====
Chart External Title Trend chart of Extra External Sensors
This is a full rebuild of the site. Please note that if you switch from HTML formated reports back to plain text reports, (OR VICA VERSA), you MUST regenerate ALL your reports and upload them using the Utilities FTP option.
Plot Extra GeigerCounter
EndChart


==Installing==
If more than one external sensor, in automatic mode all would be plotted in the one chart named External. If that is not what you want then switch to manual mode - i.e set ''UserModificationExtraSensorCharts=true'' - modify your ''CutilsCharts.def'' and run again. All other working is the same as in the standard [[Extra Sensors]] module.
Download the current zip file to you local machine and upload it to your web server.
*Unzip it in the same location as your existing site - it will not overwrite the existing pages
*:The new site uses .html pages whereas the existing default site uses .htm
*; If you visit your site without specifying a page you will be taken to the new template pages,
*;Specifying a page such as index.htm will display your old template pages.


*: Please clear your browser cache before viewing.
[[Category:CumulusUtils]]

===Your Own Pages===
'''As with previous releases, the public website template also includes a template page'''.

The template.html page is provided to make it easier for you to add your own pages while retaining the look and feel of the website. The template page is called '''template.html'''.

<big>Editing</big>
The template page shows all the different column layouts that are available. These are:
ax-column1, ax-column2, ax-column3, ax-column4, ax-column5 and ax-column6

: These will always try to display the indicated number of columns but as the screen becomes small will automatically collapse into fewer columns as appropriate.
:; If there are more panels than columns they will gracefully split onto additional rows while retaining their column settings.
:; Rows with fewer panels than columns will either stretch the remaining panels across the full width or distribute them centrally - this can be controlled by you.

For full details visit [https://oaktreewebs.co.uk/wiki/ my wiki].

==Editing the website menu==

Please refer to my [https://oaktreewebs.co.uk/wiki/ wiki] for full details of the menu and how to edit it.

==Changing the Theme and Other Settings==

Please refer to my [https://oaktreewebs.co.uk/wiki/ wiki] for full information on configuring and setting up the alternative website.

Revision as of 06:51, 7 September 2025

The default CMX website Development

These section of the Wiki will enable you to get the latest information and resources for the alternative to the default CumulusMX public website.

Alternative public website

 Please note.  This is NOT part of the CumulusMX Distribution package and is provided only for those interested in having a public site that uses similar structures to the Alternative Interface.

Although it should function at the date of release, no guarantees are given that it will continue to do so with subsequent releases of CumulusMX. Users should take time to investigate how it reacts and uses the library and data files uploaded by CumulusMX so that you are able to do some troubleshooting for yourself.

Full details of the alternative public website, including screenshots can be fond on my wiki together with comprehensive instructions on how to install, use and modify.

This site also comes with new themes (unfortunately not compatible with the AI or previous versions) that should be easier to modify for your own needs. 

Download the latest version here (Updated:  (14:30 29th July 2025) W3C Validated code.)

Amendments since last revision

This is a full rebuild of the site. Please note that if you switch from HTML formated reports back to plain text reports, (OR VICA VERSA), you MUST regenerate ALL your reports and upload them using the Utilities FTP option.

Installing

Download the current zip file to you local machine and upload it to your web server.

  • Unzip it in the same location as your existing site - it will not overwrite the existing pages
    The new site uses .html pages whereas the existing default site uses .htm
    If you visit your site without specifying a page you will be taken to the new template pages,
    Specifying a page such as index.htm will display your old template pages.
  • Please clear your browser cache before viewing.

Your Own Pages

As with previous releases, the public website template also includes a template page.

The template.html page is provided to make it easier for you to add your own pages while retaining the look and feel of the website. The template page is called template.html.

Editing The template page shows all the different column layouts that are available. These are: 

ax-column1, ax-column2, ax-column3, ax-column4, ax-column5 and ax-column6
These will always try to display the indicated number of columns but as the screen becomes small will automatically collapse into fewer columns as appropriate.
If there are more panels than columns they will gracefully split onto additional rows while retaining their column settings.
Rows with fewer panels than columns will either stretch the remaining panels across the full width or distribute them centrally - this can be controlled by you.

For full details visit my wiki.

Editing the website menu

Please refer to my wiki for full details of the menu and how to edit it.

Changing the Theme and Other Settings

Please refer to my wiki for full information on configuring and setting up the alternative website.

Retrieved from "https://www.cumuluswiki.org/index.php?title=External_Extra_Sensors&oldid=12157"