Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Julusian committed Feb 2, 2025
1 parent 06f091b commit 92befea
Show file tree
Hide file tree
Showing 17 changed files with 45 additions and 29 deletions.
5 changes: 3 additions & 2 deletions docs/1_gettingstarted/before_you_open.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
- Connect the Stream Deck surfaces that you want to use.
- Connect the Stream Deck or other surfaces that you want to use.
- In the Elgato Stream Deck app, make sure to firmware upgrade the Stream Deck to the latest version available.
- Close the Elgato Stream Deck app. Companion Satellite will not detect your device if the Elgato Stream Deck app is open.
- Close the Elgato Stream Deck app. Companion Satellite will not detect your device if the Elgato Stream Deck app is open.
- Close the application for any other surface types you wish to use.
17 changes: 0 additions & 17 deletions docs/1_gettingstarted/configure_remote_host.md

This file was deleted.

29 changes: 29 additions & 0 deletions docs/1_gettingstarted/configure_satellite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
To connect the Satellite surface to your Companion setup, you need to configure the connection.

1. Right-click on the Companion Satellite icon in the system tray.
![Context Menu](images/contextmenu.png?raw=true 'Context Menu')

If you are running Companion Satellite on a headless machine, such as a Raspberry Pi, you can instead navigate to `http://192.168.100.100:9999` (substitute the correct ip address) and access the same configuration

1. Choose "Configure" in the context menu.
This will open a new window
![Configure window](images/configure-page.png?raw=true 'Configure window')

1. Type in the IP Address or hostname of the remote server into the Address field, and click Save at the bottom.
In most cases you **should not** change the port number from the default.

1. Optionally, you can configure other settings in here.

1. Shortly after you have clicked Save, the top section should update to confirm that it has connected
![Connected Status](images/configure-connected.png?raw=true 'Connected Status')

1. Next, switch to the 'Surface Plugins' tab, and make sure that the surface types you wish to use are all enabled
![Surface Plugins](images/surface-plugins.png?raw=true 'Surface Plugins')

1. Finally, you can confirm in the 'Connected Surfaces' tab that Satellite has correctly detected each surface
![Connected Surfaces](images/connected-surfaces.png?raw=true 'Connected Surfaces')

1. You will also be able to see your surfaces in Companion, where they will appear just like other surfaces, but with the ip address of the Satellite machine under the 'Location' column

While Satellite is in the disconnected state, your surfaces will show a placeholder card to indicate this, looking like:
![Disconnected](images/disconnected.jpg?raw=true 'Disconnected')
Binary file removed docs/1_gettingstarted/images/changehost.png
Binary file not shown.
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/1_gettingstarted/images/configure-page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/1_gettingstarted/images/contextmenu.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/1_gettingstarted/images/disconnected.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/1_gettingstarted/images/disconnected.png
Binary file not shown.
Binary file removed docs/1_gettingstarted/images/ipaddress.png
Binary file not shown.
Binary file removed docs/1_gettingstarted/images/scan.png
Binary file not shown.
Binary file removed docs/1_gettingstarted/images/server_surfaces.png
Binary file not shown.
Binary file added docs/1_gettingstarted/images/surface-plugins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 6 additions & 3 deletions docs/1_gettingstarted/scan_for_surfaces.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
If you disconnect, reconnect, or add new Satellite surfaces on the local machine, you will need to have the program perform a re-scan to detect those new devices.
If you disconnect, reconnect, or add new Satellite surfaces on the local machine, Satellite should automatically detect the surfaces as they are attached.

You can do this in the Context menu by right-clicking on the Companion icon and choosing "Scan devices":
If for some reason it does not detect it by itself, you can instead trigger a rescan from either the tray icon:
![Scan](images/scan.png?raw=true 'Scan')

You should then see the new devices connect to the Companion server, and they will show up in the web GUI of the Companion server as surfaces.
or from the configuration page:
![Scan](images/scan.png?raw=true 'Scan')

They will then be detected as normal and appear in the 'Connected Surfaces' tab and in Companion.
2 changes: 1 addition & 1 deletion docs/1_welcome.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
This program is allows you to have your physical Stream Deck and other control surfaces connected via USB to your local computer but act as if they are connected to the remote Companion server. The computers do not have to be on the same subnet/vlan, but should be reachable via a TCP connection, whether this is on the same LAN or via a VPN connection.
This program is allows you to have your physical Stream Deck and other control surfaces connected via USB to your local computer but act as if they are connected to a remote Companion server. The computers do not have to be on the same subnet/vlan, but should be able to reach Companion via a TCP connection, whether this is on the same LAN or via a VPN connection.
12 changes: 6 additions & 6 deletions docs/structure.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[
{
{
"label": "Getting started",
"file": "1_welcome.md",
"children": [
Expand All @@ -12,8 +12,8 @@
"file": "1_gettingstarted/start_the_program.md"
},
{
"label": "Configure Remote Host",
"file": "1_gettingstarted/configure_remote_host.md"
"label": "Configure Satellite",
"file": "1_gettingstarted/configure_satellite.md"
},
{
"label": "Scan for Surfaces",
Expand All @@ -24,15 +24,15 @@
{
"label": "Raspberry Pi Setup",
"file:": "2_rpi.md",
"children":[
"children": [
{
"label": "Static IP Configuration",
"file": "2_raspberrypi/static_ip.md"
},
{
"label": "Reverting to DHCP",
"file": "2_raspberrypi/revert_to_dhcp.md"
}
}
]
}
]
]

0 comments on commit 92befea

Please sign in to comment.