GridNet Radio System/Documentation

From Nexus
Revision as of 10:02, 28 September 2018 by Shymus (Talk | contribs)

Jump to: navigation, search

← Gridnet Radio System

Getting Started

New to the system? Follow our Getting Started guide for information on how to get started!
This guide will help you set up a network successfully if all steps are done properly. It is highly recommended to read that guide before reading this.
Need help and don't understand the guide? Feel free to get in touch with our support by opening a ticket: Nexus Ticket Support

How To Use This Documentation

The documentation is built into three parts. Server, Radio, and Web Interface.
Every feature on here is sorted to help you find what you're looking for.
If you are unable to find something, please refer to the table of contents on the right side of the page. If you are still unable to find what you're looking for, you can try messaging in our group chat Nexus Roleplay System or file a ticket here: Nexus Ticket Support

GridNet Server

The GridNet Server is an item that is rezzed in-world. This item is used to keep the network in your name, handle distribution servers, and prevent others from stealing your network name.
When you create a network, the server will need to remain rezzed. If it is not rezzed, someone will have the ability to steal your network name. The server prevents that until you delete the network.

Configuring The Server

  1. Rez the "Nexus GridNet Server v1.0". (Remember it has to stay there for as long as you have the network.)
  2. Touch the server to begin registration & type the desired network name when prompted.
  3. Once submitting the network name, you'll receive a prompt to open the webpage. This will lead you to the GridNet Dashboard.
  4. Go to the webpage and enter a new password for your account. (Please note, all networks that you create will appear under this account.)
  5. Bam, your new network is created. Access the new network by clicking the small blue icon that appears in the upper-right hand corner of the network's box.

What Is The Server For?

The server is used for large purposes. There are multiple reasons that a network's server needs to be rezzed.

Here are some of the reasons

  • The Server acts as an interface to the web dashboard.
  • The Server allows you configure items to the network.
  • The Server creates distribution servers and manages their load.
  • The Server manages the radio network's repeater.

What Is The Network Repeater?

In the real world, a radio repeater is used to get a radio signal and repeat it over a larger distance.
For us, the radio repeater is used as a way to verify with the server that there are active and connected devices.
The repeater plays an important role in keeping the network stable. It keeps everything synced across the radios.

How Do I Know The Repeater Is Working?

Every hour you will hear morse code giving off the repeater code. This is the repeater re-syncing with the server making sure that all the radios are on the same page.
If there are no radios connected the repeater will not fire off its repeater code until a new device connects.

How Do I Disable The Repeater Noise?

The repeater morse code can easily be turned off on the web interface.

Follow These Steps To Disable It

  1. Navigate to your network dashboard.
  2. Go to the Settings page.
  3. Turn the "Enable Repeater" checkmark off.
Please remember, this does not turn the repeater permanently off, it does not affect performance with the servers. It will just turn off the noise that the repeater makes when it syncs to the server.

Configuring Items/Radios

Configuring an item to work with your network is very simple. If you have an official item we have created, the configuration is quick and simple.
STOP & READ - There are steps recommended before configuring the radio. You will need to create zones and channels before configuring.
For more information on setting up the network, please follow the Getting Started guide.

Radio Configuration

  1. Touch the server you want to configure the radio too.
  2. Touch the radio to begin configuring.
  3. Select the zone you would like to configure the radio to when prompted.
  4. Set the radio next-owner permissions to 'No Transfer'.
  5. Take the radio back into your inventory when it asks what channel to use.
  6. You can now freely distribute the radio.

Server Updates

When your server is outdated, it will be clearly visible and will inform you via floating text.
The server will not stop working just because the server is outdated. __You will not be able to configure anything to the server while in this mode.__
Worried about losing your network or data? Don't worry, Network data is NOT lost when updating.

How To Update Your Server

  1. When your server gets outdated. (Visible from the floating text.)
  2. Touch the server to request an Update USB. (Will be sent directly from our servers.)
  3. Rez the USB next to the server.
  4. Touch the USB then Touch the server.
  5. It will then start updating. (Do Not Touch or Delete Anything! If that is done, you're risking data corruption and a lost network.)
  6. Once the update is complete, the server will turn itself back on and work just like new!

GridNet Radios

This section applies to all radio models. All radios function exactly the same except models that are animated.

Configuring Items/Radios

Configuring an item to work with your network is very simple. If you have an official item we have created, the configuration is quick and simple.
STOP & READ - There are steps recommended before configuring the radio. You will need to create zones and channels before configuring.
For more information on setting up the network, please follow the Getting Started guide.

Radio Configuration

  1. Touch the server you want to configure the radio too.
  2. Touch the radio to begin configuring.
  3. Select the zone you would like to configure the radio to when prompted.
  4. Set the radio next-owner permissions to 'No Transfer'.
  5. Take the radio back into your inventory when it asks what channel to use.
  6. You can now freely distribute the radio.

Using The Radios

Now that you have your radio set up, using the radios is very easy.
When you first pull up the radio and attach it, you will need to give it a second to load. If it is your first time wearing the radio, it will configure and reset.

What Happens When Attached? =

When the radio is attached to a person, there are a few steps that happen before the radio is usable.
Here is what happens once a radio is attached.
  1. If this is your first time attaching the radio, it will clear all the settings and variables from the old owner.
  2. The radio will then check if you are banned from the network. If you are; the radio will not move any further.
  3. The radio will then check to see if group access is enabled and determine if you are in the correct group.
  4. The radio will load all the channels for the zone the radio is configured in and prompt for you to pick one.
  5. Once you have picked your channel, your radio will then register with the network and show it online. Your radio is now usable!

Radio Operations

Once operational, the radio will work in a structure of radios. The structure is very important as to who you can talk too.
This structure is very simple. Transmissions are as followed:

Global

When you send a message on the global, your message will be transmitted to every radio that is on the radio network. This includes all zones and all channels.

Zone

When you send a message on a zone, your message is sent to all radios configured to the matching zone. If your radio is configured to zone Fire Dept, then your message will go to every radio in that same zone.

Channel

When you send a message on a channel, the message will be sent to every radio in that channel only.

Radio Settings & Dialog

There are multiple settings that can be changed within the radios. This can be accessed by simply typing __/1 menu__ or touching the radio.
These settings are as defined.
  • Change Chan This will change the channel that the radio is set too. For example, if you are on Tac-1 then you can switch to another channel like Tac-2.
  • Settings This will allow you to change some of the settings for the radio in the dialog.
    • Verbose This setting will allow you to set how the message is received/transmitted to you.
      • rOwner/tOwner Sets the radio to __OwnerSay Messages__ that are received/transmitted.
      • rSay/tSay Sets the radio to __Say Messages__ that are received/transmitted.
      • rWhisper/tWhisper Sets the radio to __Whisper Messages__ that are received/transmitted.
    • Transmit Channels This will allow you to change the chat channels to other channels. Example; change /5 to /12 or other.
      • Global Sets the chat channel for Global transmissions.
      • Zone Sets the chat channel for Zone transmissions.
      • Channel Sets the chat channel for Channel transmissions.
    • Animations If your radio allows for animtaions, this is how to enable/disable them.
      • Enable Anim This will __Enable__ the animations.
      • Disable Anim This will __Disable__ the animations.
    • Sounds This will allow you to change the sounds used by the radio. (You will need to enter a UUID)
      • Transmit This will change the sound that goes off when you __Transmit__ a message.
      • Receive This will change the sound that goes off when you __Receive__ a message.
  • Call Sign Your callsign is how your name is displayed on the radios when a message is sent across Global/Zone/Channel.