Skip to content

Commit

Permalink
Added some pictures to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
grodansparadis committed Feb 7, 2025
1 parent 3efefc1 commit e8f6293
Show file tree
Hide file tree
Showing 14 changed files with 134 additions and 16 deletions.
1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
* **Introduction**
* [Start](start.md)
* [Introduction](introduction.md)
* [Demo](demo.md)

* **Setup**
* _[General](setting_up_the_system.md)_
Expand Down
44 changes: 44 additions & 0 deletions docs/demo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Demo

There are some demo locations you can use to get started with VSCP Works +. The demo data is described in the [VSCP wiki](https://github.com/grodansparadis/vscp/wiki/Demo). The current demo exports real time events from a number of nodes in the house where we have our office.

Described below is how you connect to these resource with VSCP Works +

## CANAL
![](./images/toucan_2.png)

To test CANAL you must install a CANAL driver. We recommend [TouCAN CAN adapter](https://www.rusoku.com/products) as a good starting point. You find there CANAL driver in the download section of there site. The TouCAN can also be used on Linux and on MacOS.

## SocketCan
Download and install the [VSCP Simulator](https://github.com/grodansparadis/vscp-simulator) software. It will allow you to simulate level I and level II nodes with all functionality.

A CAN adapter like TouCAN described above that supports SocketCan id definitely needed if you are serious using socketcan.

## tcp/ip
![](./images/vscp1.vscp.org.png)

Create a new tcp/ip connection with the data above and you will receive a bunch of VSCP events generated in this house. The meaning of them all is in the wiki.

## MQTT
![](./images/test.mosquitto.org.png)

Create a new MQTT connection with the data above and you will receive a bunch of VSCP events generated in this house. The meaning of them all is in the wiki.

An alternative is use mqtt.vscp.org as server with **user**: _"vscp"_ and **password**: _"secret"_.

## Demo GUID and sensor database

[Here](https://vscp.org/vscpworks/vscpworks.sqlite3) is a demo database with GUID's and sensor indexes for the nodes that publish events. Copy this file to

```bash
~/.local/share/VSCP/vscp-works/qt
```

on Linux, and to

```bash
C:\Users\<<<your user name>>>\AppData\Local\vscp-works-qt/
```
Now when you start VSCP Works + and connect to one of the above channels you will get symbolic GUID's and sensor information in the session window.
Binary file added docs/images/test.mosquitto.org.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/toucan_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/vscp1.vscp.org.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 11 additions & 11 deletions install/windows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ We use Qt Installer Framework to build the install package. You can download the
<Title>VSCP Works Installer</Title>
<Publisher>Grodans Paradis AB</Publisher>
<StartMenuDir>VSCP</StartMenuDir>
<TargetDir>@HomeDir@/VSCP/VSCP Works Qt</TargetDir>
<TargetDir>@HomeDir@/VSCP/vscp-works-qt</TargetDir>
<RemoteRepositories>
<Repository>
<Url>https://vscp.org/packages</Url>
<Enabled>true</Enabled>
<DisplayName>VSCP Project</DisplayName>
</Repository>
<Repository>
<Url>https://vscp.org/packages</Url>
<Enabled>true</Enabled>
<DisplayName>VSCP Project</DisplayName>
</Repository>
</RemoteRepositories>
<ControlScript>installscript.qs</ControlScript>
<PackageInfo>package.xml</PackageInfo>
<UserInterfaces>
<UserInterface>ui/installer.ui</UserInterface>
<UserInterface>ui/installer.ui</UserInterface>
</UserInterfaces>
<InstallerWindowIcon>icon.ico</InstallerWindowIcon>
</Installer>
Expand All @@ -59,7 +59,7 @@ function Component()
```xml
<?xml version="1.0" encoding="UTF-8"?>
<Package>
<DisplayName>VSCP Works Qt</DisplayName>
<DisplayName>VSCP Works +</DisplayName>
<Description>The VSCP toolbox</Description>
<Version>0.0.1</Version>
<ReleaseDate>2025-01-28</ReleaseDate>
Expand All @@ -84,14 +84,14 @@ function Component()
* Run the following command to build the install package:

```bash
G:\Qt\QtIFW-4.8.1\bin\binarycreator.exe -c config/config.xml -p packages installer
G:\Qt\QtIFW-4.8.2\bin\binarycreator.exe binarycreator.exe -c config/config.xml --offline-only -p packages vscp-works+-windows-installer-x.y.z
```


* Run the following command to build the install package:
* Run the following command to get the dependencies:

```bash
G:\qt\6.8.1\msvc2022_64\bin\windeployqt.exe -c config\config.xml -p packages vscpworks-installer.exe
G:\Qt\6.8.2\msvc2022_64\bin\windeployqt.exe vscp-works-qt.exe
```


Expand Down
Binary file added install/windows/config/Built_with_Qt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added install/windows/config/Built_with_Qt_logo.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: 1 addition & 1 deletion install/windows/config/config.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<Repository>
<Url>https://vscp.org/packages</Url>
<Enabled>true</Enabled>
<DisplayName>VSCP Project</DisplayName>
<DisplayName>VSCP Projects</DisplayName>
</Repository>
</RemoteRepositories>
<ControlScript>installscript.qs</ControlScript>
Expand Down
8 changes: 8 additions & 0 deletions install/windows/packages/org.vscp.vscpworks/data/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
VSCP Works +
------------

Version: 0.0.1




Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
function Component()
{
// default constructor
}

Component.prototype.createOperations = function()
{
// call default implementation to actually install README.txt!
component.createOperations();
if (systemInfo.productType === "windows") {

if (systemInfo.productType === "windows") {
component.addOperation("CreateShortcut", "@TargetDir@/README.txt", "@StartMenuDir@/README.lnk",
"workingDirectory=@TargetDir@", "iconPath=%SystemRoot%/system32/SHELL32.dll",
"iconId=2", "description=Open README file");
Expand Down
21 changes: 21 additions & 0 deletions install/windows/packages/org.vscp.vscpworks/meta/mit.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2000-2025 Åke Hedman, Grodans Paradis AB

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
9 changes: 6 additions & 3 deletions install/windows/packages/org.vscp.vscpworks/meta/package.xml
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<Package>
<DisplayName>VSCP Works Qt</DisplayName>
<DisplayName>VSCP Works +</DisplayName>
<Description>The VSCP toolbox</Description>
<Version>0.0.1</Version>
<ReleaseDate>2025-01-28</ReleaseDate>
<ReleaseDate>2025-02-06</ReleaseDate>
<Default>true</Default>
<Script>installscript.qs</Script>
<UpdateText>Update</UpdateText>
<Dependencies>
<Dependency name="vscp-works-qt" version="0.0.1" />
<Dependency name="vscp-works-qt" version="0.0.1" />
</Dependencies>
<Licenses>
<License nam="MIT" file="license.txt" />
</Licenses>
<UserInterfaces>
<UserInterface>readmecheckboxform.ui</UserInterface>
</UserInterfaces>
</Package>
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>ReadMeCheckBoxForm</class>
<widget class="QWidget" name="ReadMeCheckBoxForm">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>412</width>
<height>179</height>
</rect>
</property>
<layout class="QVBoxLayout" name="verticalLayout">
<property name="margin">
<number>0</number>
</property>
<item>
<widget class="QCheckBox" name="readMeCheckBox">
<property name="text">
<string>Open ReadMe</string>
</property>
<property name="checked">
<bool>true</bool>
</property>
<property name="tristate">
<bool>false</bool>
</property>
</widget>
</item>
</layout>
</widget>
<resources/>
<connections/>
</ui>

0 comments on commit e8f6293

Please sign in to comment.