SenSeeAct Documentation

# Install software

# Text editor

It is recommended to use a good text editor instead of Notepad that is included with Windows.

A fast editor for single files is Notepad++:
https://notepad-plus-plus.org/ (opens new window)

A good editor to work with projects containing many files is Visual Studio Code:
https://code.visualstudio.com/ (opens new window)
We have a suggested configuration of Visual Studio Code for our development environment.

# Git

The Git CLI (command-line interface) is used by several programs we are going to install.

https://git-scm.com/ (opens new window)

  • Download the Standalone Installer, 64-bit Git for Windows Setup.
  • Run the installer and check the following page:
    • Select Components: You can disable Windows Explorer Integration to keep your context menus cleaner.
  • For the rest just accept the defaults.

The Git CLI is also useful for tasks that a Git UI client does not support, for example to make files executable for Linux or MacOS.

# Git Client

Although you can use the Git CLI to get the source code from Git and manage changes, it’s easier with a user interface. For Windows we suggest one or both of these.

  • GitHub Desktop
    Has its own UI and makes it easy to view changes at a glance, and to manage branches and push and pull changes.

  • TortoiseGit
    Integrates in Windows Explorer, has a good side-by-side view of changes, and allows you to manage any file.

# GitHub Desktop

Download GitHub Desktop:
https://desktop.github.com/ (opens new window)

Run the installer. During the installation you will be asked to log in or create an account at GitHub.

# TortoiseGit

https://tortoisegit.org/download/ (opens new window)

Download the installer for 64-bit Windows.
Run the installer and accept the defaults. The installer will start the First Start Wizard. Here check the following page:

  • Configure user information: Enter your name and email address.

TortoiseGit uses overlay icons in Windows Explorer to show whether a file has been modified etc. Windows supports only a limited number of overlay icons. If you don’t see them, you can change it in the Registry:

  • Run regedit to open the Registry Editor.
  • Expand this key:
    HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\ShellIconOverlayIdentifiers
  • The keys under that key are all registered overlay icons. You can rename them to move them up in the order (for example add one or more spaces in front).

# Source Code

Choose a directory on your computer to clone Git repositories. We will call this <GITDIR>. Then clone the following repositories. Further instructions on cloning a repository with GitHub Desktop or TortoiseGit are given below.

https://github.com/RoessinghResearch/rrd-utils.git (opens new window)
Clone to: <GITDIR>\rrd-utils

https://github.com/RoessinghResearch/senseeact.git (opens new window)
Clone to: <GITDIR>\senseeact

# Clone with GitHub Desktop

# Clone with TortoiseGit

# Java

We recommend the Eclipse Temurin OpenJDK binaries from Adoptium:
https://adoptium.net/ (opens new window)

Run the installer and check the following page:

  • Custom Setup: Enable Set JAVA_HOME variable.

# Key generator

You can generate passwords and keys for configuration files with our key generator:

  • Open Terminal in this directory:
    <GITDIR>\rrd-utils\BuildTools\BuildTools-1.0.0

  • Run this to see available options:

    > .\keygenerator -h

  • For example you can generate a password with:

    > .\keygenerator -t secure_password

During the configuration in the next section, you can keep this Terminal open so you can generate a password or key where needed.

# Docker Desktop

https://www.docker.com/ (opens new window)

Click Get Started and download and run the installer. Accept the default options, and then start Docker Desktop.

You will be offered to run a tutorial. You can complete the tutorial or just click Skip tutorial.

← Configure →