Skip to content

Commit

Permalink
Added inital picture for mdf docs
Browse files Browse the repository at this point in the history
  • Loading branch information
grodansparadis committed Feb 11, 2025
1 parent c35f0ca commit bed46ea
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 4 deletions.
3 changes: 3 additions & 0 deletions docs/connection_canal.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ The `wizard button` can give you a view of what events are filtered out an not.

In all above cases the numerical base dialog can be used to set the display numerical base for all values. The default is hexadecimal but you can also use decimal, octal or binary. Numbers can be entered using any base. Just proceed hexadecimals with `0x`, octals with `0o` and binary with `0b`. No prefix will be read as decimal values.

### Configure Wizard
Some modern drivers have a `wizard` that can help you to construct the configuration string. Press `wizard...` button to open this dialog. It opens if there is help available in the driver. If you are interested in the details of how a CANAL driver supply information for this wizard you can read more [here](https://grodansparadis.github.io/vscp-doc-canal/#/canalgetdriverinfo).

## Remove a connection

Select the connection you want to remove in the treeview and right click. Select `Remove connection` in the context menu. The connection will be removed.
Expand Down
Binary file added docs/images/mdf_start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/mdf.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# MDF

![](./images/mdf_start.png)

The **M**odule **D**escription File is described fully in the specification document [here](https://grodansparadis.github.io/vscp-doc-spec/#/./vscp_module_description_file). If you create new VSCP devices you may need to create a MDF file for them. This file is used by other devices to get information about the functionality of your device amd by VSCP Works + and other higher end software to present the device in a informative and user-friendly way.

8 changes: 4 additions & 4 deletions src/canalconfigwizard.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,10 @@ CanalConfigWizard::accept()
// fitContents
//

void CanalConfigWizard::fitContents(int id)
void
CanalConfigWizard::fitContents(int id)
{
adjustSize(); // this automagically resizes the window to fit the contents
adjustSize(); // this automagically resizes the window to fit the contents
}

///////////////////////////////////////////////////////////////////////////////
Expand All @@ -109,7 +110,7 @@ void CanalConfigWizard::fitContents(int id)
void
CanalConfigWizard::showHelp(void)
{
QString link = "https://grodansparadis.github.io/vscp-works-qt/#/connection_canal?id=config-wizard";
QString link = "http://localhost:3000/#/connection_canal?id=configure-wizard";
QDesktopServices::openUrl(QUrl(link));
}

Expand Down Expand Up @@ -453,4 +454,3 @@ void
ConfigChoicePage::cleanupPage()
{
}

0 comments on commit bed46ea

Please sign in to comment.