Device Linking and better linking ui (#13645)
Co-authored-by: AJCM-git <60196617+AJCM-git@users.noreply.github.com> Co-authored-by: Visne <39844191+Visne@users.noreply.github.com> Co-authored-by: ElectroJr <leonsfriedrich@gmail.com> Co-authored-by: metalgearsloth <comedian_vs_clown@hotmail.com>
This commit is contained in:
39
Resources/ServerInfo/Guidebook/Network_Configurator.xml
Normal file
39
Resources/ServerInfo/Guidebook/Network_Configurator.xml
Normal file
@@ -0,0 +1,39 @@
|
||||
<Document>
|
||||
# Network Configurator
|
||||
The network configurator allows you to manipulate device lists and link devices together.
|
||||
<Box>
|
||||
<GuideEntityEmbed Entity="NetworkConfigurator"/>
|
||||
</Box>
|
||||
The configurator has two modes: List and Link. You can press [color=gray]Alt+Z[/color] or [color=gray]Alt+Y[/color] to switch between them.
|
||||
|
||||
## List Mode
|
||||
In list mode you can click on network devices to save them on the configurator and then on a network device that has a device list like the [color=#a4885c]Air Alarm[/color].
|
||||
|
||||
When clicking on a device like the Air Alarm, a UI will open displaying the list currently saved on the device and buttons to manipulate that list.
|
||||
|
||||
You can:
|
||||
- Replace the current list with the one saved on the configurator
|
||||
- Add the list on the configurator to the current one
|
||||
- Clear the current list
|
||||
- Copy the current list to the configurator
|
||||
- Visualize the connections to the devices on the current list
|
||||
|
||||
Pressing [color=gray]z[/color] or [color=gray]y[/color] opens the list saved on the configurator where you can remove saved devices.
|
||||
|
||||
## Link Mode
|
||||
With link mode you can click on a device that is capable of device linking and click on any other device that is either
|
||||
a sink or source.
|
||||
|
||||
For example, first clicking on a source like a [color=#a4885c]signal button[/color] and then on sink like a
|
||||
[color=#a4885c]small light[/color] opens a UI that displays the source ports on the left side and the sink ports on the right.
|
||||
|
||||
Now you can eiter click [color=gray]link defaults[/color] to link the default ports for a source + sink combination or press on a source and then a sink port to connect them.
|
||||
|
||||
An example of a default link for the aformentioned combinaton of devices would be:
|
||||
<Box>
|
||||
[color=cyan]Pressed 🠒 Toggle[/color]
|
||||
</Box>
|
||||
When you're done connecting the ports you want you can click on [color=gray]ok[/color] to close the UI.
|
||||
|
||||
You can quickly link multiple devices to their default port by first clicking on a device that can be linked and then using [color=gray]alt+left mouse button[/color] on the devices you want to link together.
|
||||
</Document>
|
||||
25
Resources/ServerInfo/Guidebook/Networking.xml
Normal file
25
Resources/ServerInfo/Guidebook/Networking.xml
Normal file
@@ -0,0 +1,25 @@
|
||||
<Document>
|
||||
# Networking
|
||||
Some devices on the station need to communicate with each other, and they do this by utilizing device networking.
|
||||
With networking machines and devices can send arbitrary data between each other.
|
||||
There are multiple networks that get used, such as the wireless and wired network.
|
||||
Each network device has a frequency it receives on. PDAs for example, use the frequency: [color=green]220.2[/color]
|
||||
|
||||
## Device Lists
|
||||
Some devices need to know what other devices to communicate with specifically.
|
||||
<Box>
|
||||
<GuideEntityEmbed Entity="AirAlarm"/>
|
||||
</Box>
|
||||
Air alarms for example require you to tell it which vents, scrubbers, sensors, and firelocks to interact with.
|
||||
You do that by using the Network Configurator.
|
||||
|
||||
## Linking
|
||||
If devices basic or still more advanced but need finer control of how and what connects to each other they will generally use device linking.
|
||||
<Box>
|
||||
<GuideEntityEmbed Entity="SignalSwitch"/>
|
||||
<GuideEntityEmbed Entity="Airlock"/>
|
||||
</Box>
|
||||
With linking you can connect the outputs of a device like [color=gray]On[/color] or [color=gray]Off[/color] with the inputs of a device like the airlocks
|
||||
[color=gray]Open[/color] or [color=gray]Close[/color] inputs.
|
||||
The Network Configurator is also used for linking devices together.
|
||||
</Document>
|
||||
Reference in New Issue
Block a user