TheHomecraft/cc-mek-scada
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated System Setup (markdown)

Mikayla 2024-05-04 11:00:40 -04:00
parent e66db7f580
commit 79ae5ff59d
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
System-Setup.md

@ -1,5 +1,8 @@
# Facility Setup Guide
> [!IMPORTANT]
> You will need to select 5 channels for use with the wireless/Ender modems in the system, please see [this page](https://github.com/MikaylaFischler/cc-mek-scada/wiki/Networking) for details.
Here you will find detailed information on how to set up your system. If you want something brief, check out [this page](https://github.com/MikaylaFischler/cc-mek-scada/wiki/Quickstart).
As a reminder, _**this system is still in beta**_. Configuration headaches may occur, though now that the graphical configuration tools are available, I hope they are lessened.
@ -11,8 +14,6 @@ For all setup, you should know how to [connect CC: Tweaked peripherals](https://
| <img width="300" alt="image" src="https://github.com/MikaylaFischler/cc-mek-scada/assets/2926271/799a4208-ecc3-46e0-9e14-91e289b8cd15"> | <img width="300" alt="image" src="https://github.com/MikaylaFischler/cc-mek-scada/assets/2926271/948e666f-35ab-4835-a6f9-115d977d6ed1"> |
**You will need to select 5 channels for use with the wireless/Ender modems in the system, please see [this page](https://github.com/MikaylaFischler/cc-mek-scada/wiki/Networking) for details.**
## Table of Contents
1. [Device Layout](#device-layout)
@ -43,7 +44,11 @@ It is **HIGHLY** encouraged that you use an ender modem rather than a standard w
A facility setup would have one supervisor computer, one coordinator computer, one reactor PLC computer per reactor, and one or more RTUs connected to the various other machines (turbines, boilers, dynamic tanks, etc).
> There can only be one supervisor and one coordinator per system. There can only be one reactor PLC per reactor. One RTU can be connected to multiple devices, such as all your turbines and boilers regardless of which reactor they are connected to, since the RTU configuration defines the actual assignments. Overloading one RTU with 10+ devices may cause it to run slower, so in that case you may want to use more than one. For further details and recommendations, see the [RTU Gateway](RTU-Gateway) page.
> [!TIP]
> There can only be one supervisor and one coordinator per system, and only one reactor PLC per reactor. However, one RTU can be connected to multiple devices, such as all your turbines and boilers regardless of which reactor they are connected to, since the RTU configuration defines the actual assignments. You can also use multiple RTUs if things are far apart!
> [!WARNING]
> Overloading one RTU with 10+ devices may cause it to run slower, so in that case you may want to use more than one. For further details and recommendations, see the [RTU Gateway](RTU-Gateway) page.
### Device Requirements
@ -113,6 +118,7 @@ Terminology:
To connect Mekanism machines to PLCs and RTUs, you can put a computer directly in contact with it or use ComputerCraft wired modems.
> [!TIP]
> When connecting devices via wired modems, make sure that the network cables don't combine different computer's peripherals, e.g. don't have a single network cable connecting multiple devices to multiple RTUs. Each RTU/PLC should only connect to the devices it uses. This won't cause software issues, but it will cause your configuration to be more confusing.
**When connecting to Mekanism machines, if the multiblock you are interacting with has a Logic Adapter (e.g. Fission Reactor Logic Adapater), you need to connect to that. Otherwise, connect to a Port (e.g. Induction Port, SPS Port) or a Valve (e.g. Boiler Valve, Turbine Valve, Dynamic Tank Valve).** If it isn't a multiblock, you can just put the modem/computer next to the device on most sides, just not on top of a Solar Neutron Activator, as it will prevent it from getting sunlight.
@ -137,6 +143,9 @@ Note that the tag/branch should generally be left alone as `main` would provide
The installation manifest file includes size information that allows the installer to verify there is sufficient space for installation. By default, files are downloaded to a temporary directory before copying them in in the case a network error interrupts the process. This would leave the current application intact.
> [!NOTE]
> By default, ComputerCraft computers have 1 MB of space available.
If there is not space and an update is requested, the user has the option to try deleting/replacing files one by one. If this fails in the end, the installation may be corrupt and should not be used until an update is successful. If there isn't space, it's generally best to just delete the log file.
### Installation
@ -155,6 +164,7 @@ Applications can be uninstalled with `ccmsi uninstall <app>` where app is the ap
## Device Setup and Configuration
> [!NOTE]
> The migration from legacy `config.lua` files to new `.settings` files is complete. At no point should you create a new `config.lua` file. If it is not present, then that means that application uses the new system and has a `configure` command available for the GUI-based configuration.
Note that any peripheral touching a computer can be on any side. Diagrams below show certain sides purely as an example. I personally think Ender modems look nice as computer hats, but place them however you want.