QuickStart Guide
Initial Setup - Step by Step
17 min
1\) start companion open the companion file (no installation necessary) typically, this is an executable file ( exe on windows, app/ dmg on macos, or an executable binary) if prompted allow the application (e g , confirm the operating system's security prompt) expected result the companion window opens and displays the user interface troubleshooting if the app doesn't start right click → "run as administrator" (windows) or allow starting in macos settings under "security & privacy" check if antivirus/smartscreen is blocking the file 2\) check network / set ip range check which subnet the device sends to by default x1 devices typically send in 192 168 0 x x2 devices typically send in 192 168 1 x set your pc's ip temporarily so that it is in the same subnet (e g , 192 168 0 10 for x1 or 192 168 1 10 for x2) windows settings → network & internet → change adapter options right click on your active adapter → properties → internet protocol version 4 (tcp/ipv4) → properties select "use the following ip address" and enter e g , ip 192 168 0 10, subnet mask 255 255 255 0, gateway empty or 192 168 0 1 macos system preferences → network → select adapter → "advanced" → tcp/ip configure "manually" → ip 192 168 0 10, subnet mask 255 255 255 0 expected result your pc has an ip in the appropriate subnet and can receive broadcast packets to devices in the same subnet troubleshooting note your normal network configuration beforehand so you can restore it later if your pc is connected via company vpn or special firewall, disable vpn or use an isolated lan (e g , via ethernet directly to a switch) 3\) search for devices (broadcast) in companion click on "search" (magnifying glass) the software sends broadcast/discovery requests and lists all found crawlers in the local broadcast range expected result all reachable crawlers appear in the device list with information such as serial number, model, current ip (if available), and status troubleshooting if no devices appear check network settings again (step 2) temporarily disable firewall on the pc or add companion to exceptions restart the device (rule out factory settings) check if the pc is physically in the same network/segment as the device (no wifi/guest network with isolation) 4\) select device / open details click once on the row of the desired crawler in the list the clickable element opens the detail view or network settings of the device expected result you see details current ip (if available), mac, network mode (dhcp/static), possibly hostname, and buttons for actions (e g , change ip, web ui, restart) troubleshooting if the detail view remains empty try double click or right click → "details" if multiple identical devices appear, orient yourself by mac or serial number 5\) adjust ip (static vs dhcp) & save changes select in the device's network settings dhcp if the device should obtain an ip automatically from the router (recommended if a dhcp server is available in the network) static ip if you want to set a fixed address (e g , 192 168 0 50) for static ip, enter ip, subnet mask (255 255 255 0), possibly gateway and dns click save / apply expected result companion confirms the change the device may perform a restart and is then reachable at the new ip practical examples device x1 static ip=192 168 0 50, subnet 255 255 255 0 device x2 static ip=192 168 1 50, subnet 255 255 255 0 troubleshooting device restarts but is not reachable check if pc is in the same subnet again when setting static ip, watch for ip conflicts (no other machine may have the same ip) use ping \<ip> or arp a (windows/macos) to check if the device responds 6\) access web ui in companion click on web ui (or open manually in browser http //\<new ip> — e g , http //192 168 0 50) wait until the web interface loads a login may be required expected result the browser displays the crawler's web ui (status, logs, configuration) troubleshooting browser warns of insecure connection (http or self signed certificate) — allow secure exception if device is internal if the page doesn't load ensure no proxy settings are interfering check firewall rules on the pc try another browser or curl http //\<ip> in a terminal if https is expected, try https //\<ip> (and accept certificate exception if necessary) additional verify & reset pc network configuration after everything is configured, reset the pc network settings to the original state (e g , dhcp) if you changed them temporarily check reachability from the normal company network (if the device is to be operated there permanently) possibly connect device to the target network or adjust dns/firewall test commands windows ping 192 168 0 50 macos / linux ping c 4 192 168 0 50 display arp cache arp a quick summary / checklist start companion set pc ip to 192 168 0 x (x1) or 192 168 1 x (x2) click on search in companion click on desired device in the list → open details select ip mode (dhcp or static) → save → restart device open web ui via button or http //\<new ip> in browser reset pc network and check reachability