Satellites plugin - Revision history

Daggerstab: /* Current format */

2012-03-11T11:52:44Z

Current format

Daggerstab: update for the latest version - needs more work and new screenshots

2012-03-11T11:47:57Z

update for the latest version - needs more work and new screenshots

Show changes

Daggerstab: /* Adding new Satellites */

2011-12-12T14:05:11Z

Adding new Satellites

Daggerstab: /* Adding new Satellites */

2011-12-12T14:03:27Z

Adding new Satellites

Daggerstab: /* Adding new Satellites */

2011-12-09T14:31:46Z

Adding new Satellites

Daggerstab at 14:11, 9 December 2011

2011-12-09T14:11:35Z

Daggerstab: /* Displaying satellite data */

2011-12-09T14:06:11Z

Displaying satellite data

Daggerstab: /* Displaying satellite data */

2011-12-09T14:05:08Z

Displaying satellite data

Daggerstab at 20:26, 12 November 2011

2011-11-12T20:26:34Z

Daggerstab: /* Adding new Satellites */

2011-02-27T09:46:30Z

Adding new Satellites

@@ Line 90: / Line 90: @@
 ===Current format===
-:''(Used in Satellites plug-in 0.7.1 and later (Stellarium 0.11.2 and later)''
+:''Used in Satellites plug-in 0.7.1 and later (Stellarium 0.11.2 and later)''
 To add a new satellite, open a new line after line 5 and paste the following, note commas and brackets, they are important:
@@ Line 119: / Line 119: @@
 * NORAD number - required parameter, surrounded by double quotes ("), followed by a colon (:). It is used internally to identify the satellite. You should replace the text "NORAD number" with the first number on both lines of the TLE set (in this case, "'''12345'''") It must match the number of the satellite in the source you are adding from if you want the TLE to be automatically updated.
-The remaining parameters should be includes in curly brackets, the closing curly bracket must be followed by a comma to separate it from the next satellite in the list:
+The remaining parameters should be listed between two curly brackets and the closing curly bracket must be followed by a comma to separate it from the next satellite in the list:
 * name - required parameter. It will be displayed on the screen and used when searching for the satellite with the Find window. Use the description field for a more readable name if you like. (The description field can accept HTML tags such as <tt><nowiki><br/></nowiki></tt> (new line), <code><nowiki><b></b></nowiki></code> (bold), etc.)
 * description - optional parameter, double quoted.  Appears when you click on the satellite

@@ Line 52: / Line 52: @@
 http://stellarium.org/wikiimg/sat_howto_07.jpg
-==Adding new Satellites==
+==Adding new satellites==
 At time of writing, there is no simple way to add and remove satellites using the GUI.  However, you can modify the <tt>satellites.json</tt> file manually using a text editor. '''If you are using Windows, it is strongly recommended to use an advanced text editor such as [http://notepad-plus-plus.org/ Notepad++]''' to avoid problems with end-of-line characters. (It will also color the JSON code and make it easier to read.)
 '''Warning:''' Before editing your <tt>satellites.json</tt>, make a backup copy.  Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium from starting.
-The path to the directory in which satellites.json can be found is something like:
+The path to the directory which contains <tt>satellites.json</tt> is something like:
 {{user data directory|modules\Satellites|modules/Satellites}}

@@ Line 53: / Line 53: @@
 ==Adding new Satellites==
-At time of writing, there is no simple way to add and remove satellites using the GUI.  However, you can modify the <tt>satellites.json</tt> file manually using a text editor.
+At time of writing, there is no simple way to add and remove satellites using the GUI.  However, you can modify the <tt>satellites.json</tt> file manually using a text editor. '''If you are using Windows, it is strongly recommended to use an advanced text editor such as [http://notepad-plus-plus.org/ Notepad++]''' to avoid problems with end-of-line characters. (It will also color the JSON code and make it easier to read.)
-Before editing your <tt>satellites.json</tt>, make a backup copy.  Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium from starting.
+'''Warning:''' Before editing your <tt>satellites.json</tt>, make a backup copy.  Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium from starting.
 The path to the directory in which satellites.json can be found is something like:

@@ Line 53: / Line 53: @@
 ==Adding new Satellites==
-At time of writing, there is no simple way to add and remove satellites using the GUI.  However, you can modify the satellites.json file manually using a text editor.
+At time of writing, there is no simple way to add and remove satellites using the GUI.  However, you can modify the <tt>satellites.json</tt> file manually using a text editor.
-Before editing your satellites.json, make a backup copy.  Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium from starting.
+Before editing your <tt>satellites.json</tt>, make a backup copy.  Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium from starting.
 The path to the directory in which satellites.json can be found is something like:
-* <tt>C:\Users\'''Username'''\AppData\Roaming\Stellarium\modules\Satellites</tt> (Vista)
+{{user data directory|modules\Satellites|modules/Satellites}}
-* <tt>C:\Documents and Settings\'''Username'''\Application Data\Stellarium\modules\Satellites</tt> (Windows XP)
 To add a new satellite, open a new line after line 5 and paste the following, note commas and brackets, they are important:
@@ Line 83: / Line 82: @@
 		},
 </PRE>
-* satellite name - required parameter, double quoted with a colon following.  Use the name as it appears in source you are updating from if you want the TLE to be automatically updated.  Use the description field for a more readable name if you like. (It can accept HTML tags such as <code><br/></code> (new line), <code><b></b></code> (bold), etc.)
+* satellite name - required parameter, double quoted with a colon following.  Use the name as it appears in source you are updating from if you want the TLE to be automatically updated.  Use the description field for a more readable name if you like. (The description field can accept HTML tags such as <tt><nowiki><br/></nowiki></tt> (new line), <code><nowiki><b></b></nowiki></code> (bold), etc.)
 The remaining parameters should be includes in curly brackets, the closing curly bracket must be followed by a comma to separate it from the next satellite in the list.:
@@ Line 96: / Line 95: @@
 and even add new satellites.
+===Online list creator===
-===Satellites.json Creator===
 A user (LCoronelP) has written a satellites.json creator in PHP using the TLE sources in your config.ini, you can use it [http://www.lbcoders.com/stellarium/createsatjson.php here], and the sourcecode is [http://www.lbcoders.com/stellarium/createsatjson.phps here].

@@ Line 1: / Line 1: @@
 {{obsolete|12 November 2011 (but the problem dates from before that)}}
 The Satellites plugin simulates satellites in Earth orbit.  Satellite orbits are not very precisely predicted using the existing orbital models for the planets, as there are other factor involved - irregularities in the Earth's gravitational field, lunar interactions, atmospheric drag and so on.
 This plugin implements the SGP4 and SDP4 models, and takes as it's input data NORAD TLEs (two line elements).  TLEs for hundreds of satellites are available online and are regularly updated.
-==Usage==
+==Enabling the Satellites plugin==
-===Enabling the Satellites plugin===
 This plugin comes bundled with Stellarium version 0.10.3, although it is not enabled by default.  To enable the plugin, open the configuration dialog and go to the plugins tab.  Click '''Satellites''' from the list of available plugins and check the '''load at startup''' checkbox.  You will need to re-start Stellarium for changes to take effect.
-===Using the Satellites plugin===
+==Using the Satellites plugin==
 To see the position of artificial satellites, you must have the observer location set to Earth.  You must also turn on Satellite indicators on the main tool bar as shown in the image below:
 http://stellarium.org/wikiimg/sat_howto_02.jpg
-====Searching for satellites====
+===Searching for satellites===
 It should now be possible to search for artificial satellites using the regular search dialog (F3).  Note that at any given time, most Satellites will be below the horizon.
 http://stellarium.org/wikiimg/sat_howto_03.jpg
-====Displaying satellite data====
+===Displaying satellite data===
 {{obsolete-section}}
 <div style="float:right">http://stellarium.org/wikiimg/sat_howto_04.jpg</div>
@@ Line 32: / Line 30: @@
 <br clear="all"/>
-====Configuration====
+===Configuration===
 When the satellites plugin is loaded, the configuration button in the plugins tab of the configuration dialog will be enabled.  Clicking this button (or pressing Control+Shift+Z) will open the configuration dialog for the satellites plugin.
-=====Settings tab=====
+====Settings tab====
 In the settings tab you can control how often the Satellites plugin downloads updates for the TLE elements of known satellites.  The default is every 72 hours.   If an update is due when Stellarium is started, it will commence 30 seconds or so after the plugin is loaded.
 http://stellarium.org/wikiimg/sat_howto_05.jpg
-=====Satellites tab=====
+====Satellites tab====
 The Satellites tab shows data on known satellites and lets you choose which ones are visible.  Note that for each satellite which is visible, Stellarium must do extra work to calculate and show the position of the satellite.  If Stellarium is running very slowly with the Satellites plugin enabled, try reducing the number of satellites which are visible.
@@ Line 49: / Line 47: @@
 http://stellarium.org/wikiimg/sat_howto_06.jpg
-=====Sources tab=====
+====Sources tab====
 The Sources tab lets you see (and modify) where Stellarium is getting its TLE data from.  The default is a list of sources from [http://celestrak.com celestrak.com].
@@ Line 85: / Line 83: @@
 		},
 </PRE>
-* satellite name - required parameter, double quoted with a colon following.  Use the name as it appears in source you are updating from if you want the TLE to be automatically updated.  Use the description field for a more readable name if you like.
+* satellite name - required parameter, double quoted with a colon following.  Use the name as it appears in source you are updating from if you want the TLE to be automatically updated.  Use the description field for a more readable name if you like. (It can accept HTML tags such as <code><br/></code> (new line), <code><b></b></code> (bold), etc.)
 The remaining parameters should be includes in curly brackets, the closing curly bracket must be followed by a comma to separate it from the next satellite in the list.:
@@ Line 105: / Line 103: @@
 Note: This generator only works if your sources are OK.
-===Additional Sources for TLE data===
+==Sources for TLE data==
-* [http://celestrak.com/NORAD/elements/ Celestrak, additional TLE sources beyond those included by default in Satellite Plug-In]
+* [http://celestrak.com/NORAD/elements/ Celestrak], additional TLE sources beyond those included by default in Satellite plug-in
 * [http://www.tle.info/joomla/index.php TLE.info]
-* [http://www.space-track.org Space Track, the definitive source, requires signup, operated by DOD]
+* [http://www.space-track.org Space Track], the definitive source, requires signup, operated by United States Department of Defense
-===TODO===
+==TODO==
 * Provide download links for alternative satellites.json files which include specialist lists of satellites.
 [[Category:Plugins]]

@@ Line 29: / Line 29: @@
 * '''Altitude''' of the satellite above the ground in kilometers
 * '''Comms''' data.  Some satellites broadcast on frequencies which can be received by the general public or used by amateur radio operators.  Where such data is known about a satellite Stellarium will show it.
 ====Configuration====

← Older revision		Revision as of 20:26, 12 November 2011
Line 1:		Line 1:
−	~~==Introduction==~~	+	{{obsolete\|12 November 2011 (but the problem dates from before that)}}
		+
	The Satellites plugin simulates satellites in Earth orbit. Satellite orbits are not very precisely predicted using the existing orbital models for the planets, as there are other factor involved - irregularities in the Earth's gravitational field, lunar interactions, atmospheric drag and so on.		The Satellites plugin simulates satellites in Earth orbit. Satellite orbits are not very precisely predicted using the existing orbital models for the planets, as there are other factor involved - irregularities in the Earth's gravitational field, lunar interactions, atmospheric drag and so on.

@@ Line 55: / Line 55: @@
 At time of writing, there is no simple way to add and remove satellites using the GUI.  However, you can modify the satellites.json file manually using a text editor.
-Before editing your satellites.json, make a backup copy.  Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium. from starting.
+Before editing your satellites.json, make a backup copy.  Leaving out the smallest detail (such as a comma or forgetting to close a curly bracket) will prevent Stellarium from starting.
-The file can be found in:
+The path to the directory in which satellites.json can be found is something like:
-* C:\Users\''userid''\AppData\Roaming\Stellarium\modules\Satellites (Vista)
+* <tt>C:\Users\'''Username'''\AppData\Roaming\Stellarium\modules\Satellites</tt> (Vista)
-* C:\Documents and Settings\Application Data\Stellarium\modules\Satellites (Windows XP)
+* <tt>C:\Documents and Settings\'''Username'''\Application Data\Stellarium\modules\Satellites</tt> (Windows XP)
 To add a new satellite, open a new line after line 5 and paste the following, note commas and brackets, they are important:
@@ Line 76: / Line 76: @@
 				"frequency": 145.825
+			   }
+                         ],
 			"groups": ["group1", "group2"],
 			"tle1": "1 12345U 90005D   09080.85236265  .00000014  00000-0  20602-4 0  5632",
@@ Line 87: / Line 87: @@
 The remaining parameters should be includes in curly brackets, the closing curly bracket must be followed by a comma to separate it from the next satellite in the list.:
 * description - optional parameter, double quoted.  Appears when you click on the satellite
-* comms- optional parameter, square bracketed list of curly bracketed communications information.
+* comms- ''optional parameter'', square bracketed list of curly bracketed communications information.
-* groups - optional parameter, comma separated list of double quoted group names contained in square brackets.  Used for grouping satellites in the drop down box on the config (see above)
+* groups - ''optional parameter'', comma separated list of double quoted group names contained in square brackets.  Used for grouping satellites in the drop down box on the config (see above)
 * tle1 - required parameter, line 1 of the TLE, must be contained in double quotes and begin with "1 "
 * tle2 - required parameter, line 2 of the TLE, must be contained in double quotes and begin with "2 "
@@ Line 111: / Line 111: @@
 ===TODO===
 * Provide download links for alternative satellites.json files which include specialist lists of satellites.
 [[Category:Plugins]]