Skip to main content
Version: 4.2 (beta)

Getting Started with HSYCO

Let's discover HSYCO in less than 10 minutes.

Getting Started​

Get started by creating a new HSYCO project.

What you'll need​

Deploying​

Follow this documentation for wiring and installation: HSYCO server installation

First Login​

Turn on your HSYCO server and type this URL: https://192.168.1.50 or https://hsycoserver.local/. If the wizard is active you will see the wizard splash page.

If the wizard is not active you should access via this URL: https://192.168.1.50/hsycoserver/manager

Then skip the wizard steps and go to the the step by step first configuration.

Default login:

PIN: 00000

PUK: 00000 0000 0000

info

HSYCO is pre-configured with a static IP address, 192.168.1.50. If your LAN is not on this IP range, you will need to temporarily assign an IP address within this range to your PC, for example, 192.168.1.51 with a subnet mask of 255.255.255.0. This process varies depending on the operating system running on the pc you are using to configure HSYCO.

info

Because the SSL certificate used to secure the communication between the Web Browser and HSYCO SERVER is self-generated, you will be asked to accept the server's certificate. Follow your browser dialog boxes to permanently accept the certificate.

tip

You can copy and paste PIN and PUK from a document directly in the LOGIN page.

The First Installation Wizard​

The HSYCO Wizard guides you through the initial setup of HSYCO with simple, step-by-step instructions.

Wizard Intro

Ther first step is the creation of ad administrator user.

  • The user ID must be 4 to 16 letters and digits long, no spaces, no capital letters.
  • PIN: the Personal Identification Number (PIN) is a five digit number that uniquely identifies the user
  • PUK: the Personal Unlock Key (PUK) is a fourteen digit number that is used to create the initial peering between the web client and the serve

Wizard Intro

caution

The default pre-configured PIN and PUK are 00000/00000000000000 for all HSYCO SERVERS, to let you conveniently access the user interface during the initial installation. You can skip the administrator user creation but we suggest not to do it and to create a new administration user in this phase of the configuration process.

Wizard Intro

This password is the SSH secure protocol password. SSH is used to access the operating system’s console and, if needed, to manage files. The SSH protocol encrypts all traffic and can be safely used for remote management.

caution

In order to guarantee the system safety and to prevent any unauthorized access it is essential to modify the access password of the HSYCO user before installing the system onto any not-secure LAN network.

Wizard Intro

To protect against malicious service discovery robots, HSYCO does not answer to Web requests where only the server address is defined, for example https://192.168.1.50, but requires an extended URL, which must include an access key, called URLKey.

note

The URLKey must be at least 8 characters long.

The URLKey is not a secret password, but only an additional protection feature.

Wizard Intro

The next step is the network configuration. Depending on the hardware platform on which HSYCO is installed, it can have one or two Ethernet ports. In this section, you are only allowed to configure the ETH0 port. For additional Ethernet ports, there is a separate configuration section in the Manager Settings utility.

Wizard Intro

If the hardware platform on which HSYCO is installed has a Wi-Fi adapter, in this section it is possible to activate the Wi-Fi, then scan the area for available Wi-Fi networks, select an SSID, and enter the password to connect to it.

Wizard Intro

The Wizard ends by asking to save and reboot the configuration. HSYCO automatically re-starts, the execution of HSYCO is signalled by three consecutive high-pitch beeps. You will be automatically re-direct to HSYCO Manager splash screen.

Congratulations, you can now start using HSYCO and follow one of our tutorials.

Step By Step First Configuration​

From the Manager splash screen select Settings

Manager Splash Screen

Then select Users

Users​

By default, in cases where the initial configuration wizard has been skipped, a single user will exist, identified by the generic id: "user".

Manager User Creation

Click on + to add a new user.

Manager Add User

  • User ID: the unique user id of your user (4 to 16 letters and digits)
  • Administrator: administrators have access to the Manager interface. As we are in the process of creating a new administrative user, this checkbox must be selected
  • Enabled: enable or disable the current user. Since we are creating a new user this checkbox must be selected.
  • PIN: the Personal Identification Number (PIN) is a five digit number that uniquely identifies the user
  • PUK: the Personal Unlock Key (PUK) is a fourteen digit number that is used to create the initial peering between the web client and the server. With AuthenticationStrengthCheck enabled (the default), PUKs and passwords that are easy to guess are rejected, with a message that explains why
  • Access: tick the chechbow to allow the access to all existing projects
  • Projects: or you can select one by one the projects that the new user is allowed to access
  • New PUK at Login: the user must choose a new PUK (or password) at the next login. Use it when you give the user a temporary PUK. The flag is cleared when the user sets the new PUK

Press Confirm to add the new user.

You should see 2 users in the users list.

Press the Save button in the lower right corner to create the new user. A popup will appear to double ask for confirmation.

Manager Splash Screen

The new user has no OTP key, the code generator for the two-factor authentication (see OTPAuthenticationTrustedNet): the OTP Key column reads Not set. To issue the key, press the key button in the OTP column of the new user, and confirm. The New OTP Key popup shows the key: scan the QR code with the user's authenticator app, or copy the key with the Copy button and enter it in the app. The key isn't shown again. Select I've saved this OTP key to enable OK.

New OTP Key

The OTP Key column now reads Set. The same button issues a new key to a saved user, your own included, whenever a key has been lost: the previous key stops working immediately.

When you edit a saved user, leave the PIN or the PUK empty to keep it. You can edit your own user too: change its PIN and PUK and the New PUK at Login flag. You can't delete or disable your own user, remove its administrator rights or change its ID, and you can't restrict its projects when it has access to all of them, because administrators restricted to some projects can't use the Manager. A new PIN ends all your sessions, including the current one: log in again with the new PIN.

Now it's necessary to log out and log in with the newly created user. Click on this icon Manager Splash Link to go back to che Manager splash screen then select Logout.

Manager Splash Screen

Login with the PIN/PUK credentials of the newly created user.

Select Settings then Users.

Select the default user.

Manager Delete User

Then delete it by pressing on the trash bin icon. Confirm deleting then, as seen before, click the Save button in the lower right corner.

caution

The default pre-configured PIN and PUK are the same for all HSYCO SERVERS, to let you conveniently access the user interface during the initial installation. As illustrated in the preceding steps, both the PIN and PUK should be changed immediately to different, hard to guess numbers.

SSH Password​

Let's go back to the Manager splash page and select Settings then General :

Manager Admin SSH

This password is the SSH secure protocol password. SSH is used to access the operating system’s console and, if needed, to manage files. The SSH protocol encrypts all traffic and can be safely used for remote management.

caution

In order to guarantee the system safety and to prevent any unauthorized access it is essential to modify the access password of the HSYCO user before installing the system onto any not-secure LAN network.

Manager Admin SSH

Enter a valid password (8 to 16 letters and digits) then press Save

Network Settings​

Let us now proceed to the Network Settings in the Network section of the Settings :

Manager Network

The upper table contains the list of Ethernet and Wi-Fi interfaces available on the HSYCO server. The list may vary from server to server, depending on the presence of one or two Ethernet ports and the Wi-Fi adapter.

The main Ethernet port is usually listed as 'eth0,' the secondary Ethernet port as 'eth1,' and so on. The Wi-Fi adapter, if present, is listed as 'wlan0.'

To add a new interface click on the + icon.

Manager Network

In this example we are adding a wlan0 interaface, configured in DHCP.

To change the network settings of an interface, select it then click on edit.

To add an additional IP on the same interface click the + icon then select an existing interface then add a new IP address.

Manager Network

The additional IP address is listed with the ":n" suffix.

Manager Network

In the case of multiple interfaces, the first one (max priority) in the list has the router and DNS enabled. For other interfaces, the router and DNS are automatically disabled.

Manager Network

It is possible to change the priority order of an interface by clicking on the icon Manager Network on the right side of the table, then dragging the selected row up or down.

Wi-Fi SSIDs​

The second table, the one on the lower side, shows the list of Wi-Fi SSIDs. You can add a new SSID my clicking on the + icon.

Manager Network

The priority field determines the connection order. HSYCO will first try to connect to the SSID with priority 1 and, in case of a connection failure, will proceed to the next ones in order.

Manager Network

To confirm the new network settings, click on the Save button in the bottom right corner. After making the changes, you have 5 minutes to log in again to any HSYCO interface to confirm your changes.

tip

HSYCO implements a safety mechanism that in most cases would automatically revert, after 5 minutes from the change, the network settings to the original configuration if for any reason network access to HSYCO is lost after a change.

Clock Settings​

Finally, let's take a look at the clock settings under Settings then Clock:

By default the time is set to on HSYCO automatically by polling Network Time Protocol (NTP) servers.

To access the clock configuration the Time Auto Update must be disabled.

Manager Admin Clock

Manager Admin Clock

To change the time settings, enter the new parameters and press Save.

All the other parameters are read-only in this clock configuration popup, and can be set using the Settings menu, as explained in the Settings chapter.

Restoring a previous backup​

To restore a previous backup read the Backup, Restore, Update section

Start using HSYCO​

Now that HSYCO has a new user, a new SSH password, the network and clock settings have been checked, HSYCO is ready to be used.

HSYCO is a flexible framework you can use as a supervisory interface, a protocol gateway, a development environment (with or without an end‑user interface), or any combination of these. Because of this flexibility, there’s no single required setup order. Here are some suggestions for the next steps: