Skip to content

Commit

Permalink
Update for kOS v1.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
hvacengi committed Dec 6, 2016
1 parent 273db7a commit 74ac672
Show file tree
Hide file tree
Showing 187 changed files with 6,874 additions and 1,582 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 948955b4c8b77638efdb381685db55ea
config: 2ee0a1f4e8f189d497ac05c3a0f7a36c
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file removed _images/applauncher_panel.png
Binary file not shown.
Binary file added _images/controlPanelWindow.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 _images/envelope.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 _images/inGameDifficultyButton.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 _images/newGameDifficultyButton.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 _images/noise.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 _images/sawtooth.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 _images/settingsWindow.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 _images/sine.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 _images/square.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 _images/triangle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions _sources/addons.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Addon Reference
Kerbal Alarm Clock <addons/KAC>
Infernal Robotics <addons/IR>
DMagic Orbital Science <addons/OrbitalScience>
Trajectories <addons/Trajectories>

To help KOS scripts identify whether or not certain mod is installed and available following suffixed functions were introduced in version 0.17

Expand All @@ -38,3 +39,8 @@ Returns True if mod Kerbal Alarm Clock is installed and available to KOS.
--------------------------

Returns True if mod Infernal Robotics is installed, available to KOS and applicable to current craft. See more :doc:`here <addons/IR>`.

``ADDONS:TR:AVAILABLE``
------------------------

Returns True if a compatible version of the mod Trajectories is installed. See more :doc:`here <addons/Trajectories>`.
8 changes: 8 additions & 0 deletions _sources/addons/RemoteTech.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ current game installation by usng the boolean expression
Interaction with kOS
--------------------

.. note::

.. versionadded:: v1.0.2
kOS now supports access to connection informaion from a unified location.
See :ref:`Connectivity Managers <connectivityManagers>` for more
information. All of the previous implementation as detailed on this page
remains supported.

When you have RemoteTech installed you can only interact with the core's terminal when you have a connection to KSC on any unmanned craft. Scripts launched when you still had a connection will continue to execute even if your unmanned craft loses connection to KSC. But you should note, that when there is no connection to KSC the archive volume is inaccessible. This will require you to plan ahead and copy necessary scripts for your mission to probe hard disk, if your kerbals and/or other scripts need to use them while not connected.

If you launch a manned craft while using RemoteTech, you are still able to input commands from the terminal even if you do not have a connection to the KSC. The archive will still be inaccessible without a connection to the KSC. Under the current implementation, there is no delay when accessing the archive with a local terminal. This implementation may change in the future to account for delays in reading and writing data over the connection.
Expand Down
8 changes: 0 additions & 8 deletions _sources/addons/Trajectories.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,6 @@ current version. This means that future Trajectories updates may break this
addon, in which case ``ADDONS:TR:AVAILABLE`` will return false. It is also
possible for future versions of Trjectories to remain fully compatible.

.. warning::

As of this publishing, this is not compatible with the currently released
version of Trajectories (1.6.3) due to an issue with including the API file.
This will work if you compile from
:ref:`the source<https://github.com/neuoy/KSPTrajectories/tree/69d56fecf62805752ee34e9221a57f5cb95f63b5>`
and future release versions of Trajectories should be supported as well.

.. note::

Trajectories only predicts the trajectory of the "Active Vessel," which is the vessel with the camera focused on it. :attr:`IMPACTPOS<TRAddon:IMPACTPOS>`, :attr:`PLANNEDVEC<TRAddon:PLANNEDVEC>`, :meth:`SETTARGET<TRAddon:SETTARGET>`, and :attr:`CORRECTEDVEC<TRAddon:CORRECTEDVEC>` will throw exceptions if you try to call them from an inactive vessel or if Trajectories has not calculated an impact position. You should always check if :attr:`HASIMPACT<TRAddon:HASIMPACT>` is true before accessing these suffixes.
Expand Down
14 changes: 14 additions & 0 deletions _sources/bindings.txt
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,20 @@ TIME is the time since the entire saved game campaign started, in the
kerbal universe's time. i.e. TIME = 0 means a brand new campaign was
just started.

.. object:: HOMECONNECTION

.. seealso::

:global:`HOMECONNECTION`
Globally bound variable for the connection to "home".

.. object:: CONTROLCONNECTION

.. seealso::

:global:`CONTROLCONNECTION`
Globally bound variable for the connection to a control source.

KUNIVERSE
~~~~~~~~~

Expand Down
56 changes: 56 additions & 0 deletions _sources/changes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,62 @@ release.

****

Changes in 1.0.2
----------------

Sound/Kerbal Interface Device (SKID)
::::::::::::::::::::::::::::::::::::

The SKID chip allows scripts to output procedural sound clips. Great for custom
error tones, or for playing simple music. A basic example would be::

SET V0 TO GETVOICE(0). // Gets a reference to the zero-th voice in the chip.
V0:PLAY( NOTE(400, 2.5) ). // Starts a note at 400 Hz for 2.5 seconds.
// The note will play while the program continues.
PRINT "The note is still playing".
PRINT "when this prints out.".

For an example of a song, check out the :ref:`Example song section of voice documentation<voicesong>`

Also check out the :ref:`SKID chip documentation<skid>` for an indepth explaination.

CommNet Support
:::::::::::::::

kOS now supports communications networks through KSP's stock CommNet system as
well as RemoteTech (only one networking system may be enabled at a time). The
underlying system was modified and abstracted to allow both systems to use a
common interface. Other mods that would like to add network support can
implement this system as well without a need to update kOS itself.

Check out the :ref:`Connectivity Managers documentation here<connectivityManagers>`

Trajectories Support
::::::::::::::::::::

If you have the Trajectories mod for KSP installed, you can now access data from
that structure using :struct:`ADDONS:TR<TRAddon>`. This provides access to
impact prediction through the Trajectories mod. For example::

if ADDONS:TR:AVAILABLE {
if ADDONS:TR:HASIMPACT {
PRINT ADDONS:TR:IMPACTPOS.
} else {
PRINT "Impact position is not available".
}
} else {
PRINT "Trajectories is not available.".
}

For more information see the :ref:`Trajectories Addon Documentation<Trajectories>`

Also Added
::::::::::

* :attr:`GeoCoordinates:VELOCITY` and :meth:`GeoCoordinates:ALTITUDEVELOCITY()`
* :meth:`String:TONUMBER()`
* :attr:`SteeringManager:ROLLCONTROLANGLERANGE`

Changes in 1.0.1
----------------

Expand Down
97 changes: 97 additions & 0 deletions _sources/commands/communication.txt
Original file line number Diff line number Diff line change
Expand Up @@ -143,3 +143,100 @@ The receiving CPU will use :attr:`CORE:MESSAGES` to access its message queue::
} ELSE {
PRINT "Unexpected message: " + RECEIVED:CONTENT.
}

.. _connectivityManagers:

Connectivity Managers
---------------------

.. note::

.. versionadded:: v1.0.2
The concept of selectable connectivity managers was added after KSP
introduced a stock communications system (CommNet). kOS was updated to
support both CommNet and RemoteTech. Other mods may be supported or
provide their own support in the future.

kOS can implement communications over a variaty of connectivity configurations.
We refer to these options as "Connectivity Managers." You can slect the active
manager from the :ref:`kOS section of KSP's Difficulty Settings<settingsWindow>`.
If the currently selected manager no longer is available, or if a new manager
becomes available, you will be prompted with a dialog box to select the manager
you want to use.

.. object:: Connectivity Managers

By default kOS supports the following list of managers. If a manager is not
currently available (because the required mod isn't installed, or the system
is disabled in the settings) it will not be shown in lists of available managers.

PermitAllConnectivityManager
This manager will permit all connectivity at all times. Connections
between vessels, home, and control always show as being connected. This
is the equivalent of setting ``CONFIG:RT`` to ``False`` under the former
system. It is possible kOS will be unable to use all features if this
manager is selected while communication limitations are enforced by
another mod or a setting.
CommNetConnectivityManager
This manager will use KSP's stock CommNet implementation to monitor
connections. It will only be available if CommNet is enabled in the KSP
difficulty settings.

.. note::

CommNet has limitations on updating connections for vessels
which are not the active vessel. The best way to ensure that a connection
is updated is to include one of the kinds of antenna that can act as
a relay on one or both of the vessels.
RemoteTechConnectivityManager
This manager will use the RemoteTech mod to monitor connections. It will
only be available if RemoteTech is installed. You can access more
detailed information and methods using the :ref:`RemoteTech Addon<remotetech>`

.. warning::

Take care when configuring your game for connectivity. Enabling
multiple systems at the same time may result in unexpected behaviors
both for the game connectivity itself, and for kOS's connectivity
manager. kOS only supports selecting one connectivity manager at a time
and you should ensure that only the corresponding in game connectivity
system is enabled.

You can check communication status between vessels by checking the
:attr:`Vessel:CONNECTION`. To monitor the status for home and control
connections the following bound variables are available. This allows you to
monitor the basic network status using a single unified system, regardless of
which connectivity manager is selected.

.. global:: HOMECONNECTION

Returns a :struct:`Connection` representing the :ref:`CPU Vessel's<cpu vessel>`
communication line to a network "home" node. This home node may be the KSC
ground station, or other ground stations added by the CommNet settings or
RemoteTech. Functionally, this connection may be used to determine if the
archive volume is accessible.

.. warning::

Attempting to send a message to the "home" connection will result in an
error message. While this connection uses the same structure as when
sending inter-vessel and inter-processor messages, message support is
not included.

.. global:: CONTROLCONNECTION

Returns a :struct:`Connection` representing the :ref:`CPU Vessel's<cpu vessel>`
communication line to a control source. This may be the same as the
:global:`HOMECONNECTION`, or it may represent a local crewed command pod,
or it may represent a connection to a control station. When using the
``CommNetConnectivityManager`` this should show as connected whenever a vessel
has partial manned control, or full control. Functionally this may be used
to determine if terminal input is available, and what the potential signal
delay may be for this input.

.. warning::

Attempting to send a message to the "control" connection will result in
an error message. While this connection uses the same structure as when
sending inter-vessel and inter-processor messages, message support is
not included.
56 changes: 0 additions & 56 deletions _sources/commands/flight/warp.txt

This file was deleted.

4 changes: 3 additions & 1 deletion _sources/general.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ These topics discuss the interfacing between **kOS** and **Kerbal Space Program*

Game Part <general/kospartmodule>

Launcher Panel <general/applauncher_panel>
Settings Windows <general/settingsWindows>

Telnet Server <general/telnet>

Files & Volumes <general/volumes>
Machine Code <general/compiling>

Sound Chip (SKID) <general/skid>

Name Tags <general/nametag>
Parts & PartModules <general/parts_and_partmodules>

Expand Down
18 changes: 0 additions & 18 deletions _sources/general/applauncher_panel.txt

This file was deleted.

Loading

0 comments on commit 74ac672

Please sign in to comment.