Wiki in Space - User contributions [en]

Wiki in Space:Privacy policy

2018-06-18T23:03:14Z

Kuroneko: /* How the Information is used */ Explicitly defining behaviours that may result in details being given to an anti-spam aggregation service.

== Information that is gathered from visitors ==

In common with other websites, log files are stored on the web server saving details such as the visitor's IP address, browser type, referring page and time of visit.

Cookies may be used to remember visitor preferences when interacting with the website.

For registered users, the visitor's email and a username, and, if provided, their real name, will be stored on the server.

== How the Information is used ==

The information is used to enhance the vistor's experience when using the website to display personalised content, and to deliver notifications about the website as requested by the visitor.

Accounts found to be spamming may have their details, including, but not limited to, their registered e-mail address and recently used IP address(es), given to a anti-spam aggregation service for the purpose of preventing further spam.

Information provided may also be used to identify the visitor for administrative purposes, such as, but not limited to, administering additional privileges or administrative bans.

Other than the instance above, E-mail addresses of users will not be sold, rented or leased to 3rd parties.

For the purposes of the above, spamming is defined as:
# repeatedly adding irrelevant content to the Wiki; or
# linking to external sites containing irrelevant content; or
# editing existing pages to add irrelevant content; or
# adding content that promotes a commercial activity not explicitly authorised by the Administrator(s); or
# any action significantly similar to these items.

Irrelevant content is considered to be:
# any content that is not related to the game, Objects in Space; and
# any content that is not related to their developer, Flat Earth Games; and
# any content area that can be reasonably considered to be of interest to a person playing, developing for, or modifying the game, Objects in Space

== Visitor Options ==

If you simply wish to view the contents of this site, you do not need to accept any cookies or register.

If you wish to contribute, then registration is required, and a valid email address is required as part of that registration. Contributors are not required to provide their real name.

== Cookies ==

Cookies are small digital signature files that are stored by your web browser that allow your preferences to be recorded when visiting the website. Also they may be used to track your return visits to the website.

Wiki in Space:Privacy policy

2018-06-18T22:49:24Z

Kuroneko: Update to Privacy Policy regarding use of registered spammers details

== Information that is gathered from visitors ==

In common with other websites, log files are stored on the web server saving details such as the visitor's IP address, browser type, referring page and time of visit.

Cookies may be used to remember visitor preferences when interacting with the website.

For registered users, the visitor's email and a username, and, if provided, their real name, will be stored on the server.

== How the Information is used ==

The information is used to enhance the vistor's experience when using the website to display personalised content, and to deliver notifications about the website as requested by the visitor.

Accounts found to be spamming the Wiki may have their details, including, but not limited to, their registered e-mail address and recently used IP address(es), given to a anti-spam aggregation service for the purpose of preventing further spam.

Information provided may also be used to identify the visitor for administrative purposes, such as, but not limited to, administering additional privileges or administrative bans.

Other than the instance above, E-mail addresses of users will not be sold, rented or leased to 3rd parties.

== Visitor Options ==

If you simply wish to view the contents of this site, you do not need to accept any cookies or register.

If you wish to contribute, then registration is required, and a valid email address is required as part of that registration. Contributors are not required to provide their real name.

== Cookies ==

Cookies are small digital signature files that are stored by your web browser that allow your preferences to be recorded when visiting the website. Also they may be used to track your return visits to the website.

Main Page

2018-06-04T23:30:46Z

Kuroneko: Reverted edits by Fugue (talk) to last revision by Kuroneko

The Unofficial Objects in Space Wiki

= What is Objects in Space? =

Objects in Space is a modempunk stealth space-trading game set in Apollo – a huge cluster of star systems dozens of lightyears away from Earth. You are a lonesome ship’s captain, buying and selling wares in order to keep your bucket of bolts afloat and stay one step ahead of pirates, organised criminals, corrupt governments and shady laws. (From the [http://www.objectsgame.com official web site])

= Features =

Objects in Space sees players travel all across the Apollo cluster.

[[:Category:Sectors|Sectors]] -- [[:Category:Stations|Stations]] -- [[:Category:Commodities|Commodities]]

[[:Category:Ships|Ships]] -- [[:Category:Modules|Modules]] -- [[:Category:Components|Components]]

[[:Category:Organisations|Organisations]] -- [[People]] -- [[Contracts]]

[[:Category:HardwareInterfacing|Interfacing with Hardware]]

TipsForDealingWithSerial

2018-06-04T04:23:41Z

Kuroneko: /* General */ the protocol uses LFs, not CRs.

Some generic tips for dealing with Serial Protocols

== General ==

* Bear in mind the size of your buffers - if your transmit buffer is small, during the "Synchronisation" phase, make sure your tx buffer is empty/has enough space (or that your serial library will block until transmission is complete) before sending the next configuration item as most microcontrollers easily run fast enough to outpace 9600bps serial.

* Because almost all microcontrollers can outpace serial transmissions, there can be a significant time delay between characters. Be prepared to use a blocking read that will wait until a end of line occurs, or to reconstruct the string yourself.

* If you get a RX Overrun, your best option with the OIS protocol right now is to discard bytes up until the next LF.

* Because of the format of the messages, you really should check for RX overruns as you read the messages sent by the host - an overrun can very easily change the intent of a message and cause unexpected behaviour, particularly if your channel numbers are similar. (a channel 20 message could be misinterpreted as being channel 2 for example).

== Arduino Specific ==

* Arduino's USB Serial port is implemented in one of two ways depending upon the specific model: Either USB-Serial adapter IC directly connected to USART 0 (most models); or Direct ACM CDC implemented on the AVR itself (Leonardo, some others). With CDC, bit rate commands are a technicality to maintain compatibility with real serial - it has no meaning however (data flows at USB speeds, packet by packet), and with the serial converters, because the converter is wired back to back with the microcontroller, you can safely push the bitrate up. Speeds of 19200-57600 bps should be safely usable as long as you can get the host to agree.

* Don't try to be too generic in your Arduino code - the Arduino library itself is quite inefficient, and you will save a lot of cycles by just doing what you specifically need to do directly, rather than trying to have a degree of runtime configurable behaviour.

* Use pin change interrupts rather than polling the pins for input.

[[Category:HardwareInterfacing]]

TipsForDealingWithSerial

2018-06-04T04:22:56Z

Kuroneko: /* General */

Some generic tips for dealing with Serial Protocols

== General ==

* Bear in mind the size of your buffers - if your transmit buffer is small, during the "Synchronisation" phase, make sure your tx buffer is empty/has enough space (or that your serial library will block until transmission is complete) before sending the next configuration item as most microcontrollers easily run fast enough to outpace 9600bps serial.

* Because almost all microcontrollers can outpace serial transmissions, there can be a significant time delay between characters. Be prepared to use a blocking read that will wait until a end of line occurs, or to reconstruct the string yourself.

* If you get a RX Overrun, your best option with the OIS protocol right now is to discard bytes up until the next CR.

* Because of the format of the messages, you really should check for RX overruns as you read the messages sent by the host - an overrun can very easily change the intent of a message and cause unexpected behaviour, particularly if your channel numbers are similar. (a channel 20 message could be misinterpreted as being channel 2 for example).

== Arduino Specific ==

* Arduino's USB Serial port is implemented in one of two ways depending upon the specific model: Either USB-Serial adapter IC directly connected to USART 0 (most models); or Direct ACM CDC implemented on the AVR itself (Leonardo, some others). With CDC, bit rate commands are a technicality to maintain compatibility with real serial - it has no meaning however (data flows at USB speeds, packet by packet), and with the serial converters, because the converter is wired back to back with the microcontroller, you can safely push the bitrate up. Speeds of 19200-57600 bps should be safely usable as long as you can get the host to agree.

* Don't try to be too generic in your Arduino code - the Arduino library itself is quite inefficient, and you will save a lot of cycles by just doing what you specifically need to do directly, rather than trying to have a degree of runtime configurable behaviour.

* Use pin change interrupts rather than polling the pins for input.

[[Category:HardwareInterfacing]]

TipsForDealingWithSerial

2018-06-03T21:49:42Z

Kuroneko:

Some generic tips for dealing with Serial Protocols

== General ==

* Bear in mind the size of your buffers - if your transmit buffer is small, during the "Synchronisation" phase, make sure your tx buffer is empty/has enough space (or your serial library will block until transmission is complete) before sending the next configuration item as most microcontrollers easily run fast enough to outpace 9600bps serial.

* Because almost all microcontrollers can outpace serial transmissions, there can be a significant time delay between characters. Be prepared to use a blocking read that will wait until a end of line occurs, or to reconstruct the string yourself.

* If you get a RX Overrun, your best option with the OIS protocol right now is to discard bytes up until the next CR.

* Because of the format of the messages, you really should check for RX overruns as you read the messages sent by the host - an overrun can very easily change the intent of a message and cause unexpected behaviour, particularly if your channel numbers are similar. (a channel 20 message could be misinterpreted as being channel 2 for example).

== Arduino Specific ==

* Arduino's USB Serial port is implemented in one of two ways depending upon the specific model: Either USB-Serial adapter IC directly connected to USART 0 (most models); or Direct ACM CDC implemented on the AVR itself (Leonardo, some others). With CDC, bit rate commands are a technicality to maintain compatibility with real serial - it has no meaning however (data flows at USB speeds, packet by packet), and with the serial converters, because the converter is wired back to back with the microcontroller, you can safely push the bitrate up. Speeds of 19200-57600 bps should be safely usable as long as you can get the host to agree.

* Don't try to be too generic in your Arduino code - the Arduino library itself is quite inefficient, and you will save a lot of cycles by just doing what you specifically need to do directly, rather than trying to have a degree of runtime configurable behaviour.

* Use pin change interrupts rather than polling the pins for input.

[[Category:HardwareInterfacing]]

ExternalProtocol

2018-06-03T02:54:37Z

Kuroneko: /* Protocol Details */ the compiler sets char encoding, not the runtime.

Objects in space was made with the intention that it could be playable with just buttons.

You can also get almost all the information from the in-game UI sent back to your Arduino or other external microcontroller that can speak Serial.

There are 193 Commands [[Serial Commands]], 164 Boolean Requests, and 24 Numeric Requests for a total of 381

== Protocol Details ==

The protocol is outlined on the [http://objectsgame.com/the-controllers/ois-serial-data-protocol/ offical web site], however there are some minor inaccuracies whilst the game is in Beta.

To connect your controller to the game you need to send 451 with a newline at the end. The game will send back 452. (source [http://forum.objectsgame.com:88/t/ois-arduino-code-during-beta/911/13 Nocturnal])

Also, contrary to the documentation, the newline character is LF (Dec: 10, Hex 0x0A), not CR (Dec: 13, Hex 0x0D). (note: Most C compilers encode <code>'\n'</code> as LF (CR would be <code>'\r'</code>), so the sample codes provided is correct, just the description on the page is wrong).

[[Category:HardwareInterfacing]]

ExternalProtocol

2018-06-03T02:46:49Z

Kuroneko: /* Protocol Details */

Objects in space was made with the intention that it could be playable with just buttons.

You can also get almost all the information from the in-game UI sent back to your Arduino or other external microcontroller that can speak Serial.

There are 193 Commands [[Serial Commands]], 164 Boolean Requests, and 24 Numeric Requests for a total of 381

== Protocol Details ==

The protocol is outlined on the [http://objectsgame.com/the-controllers/ois-serial-data-protocol/ offical web site], however there are some minor inaccuracies whilst the game is in Beta.

To connect your controller to the game you need to send 451 with a newline at the end. The game will send back 452. (source [http://forum.objectsgame.com:88/t/ois-arduino-code-during-beta/911/13 Nocturnal])

Also, contrary to the documentation, the newline character is LF (Dec: 10, Hex 0x0A), not CR (Dec: 13, Hex 0x0D). (note: Most C runtimes encode <code>'\n'</code> as LF (CR would be <code>'\r'</code>), so the sample codes provided is correct, just the description on the page is wrong).

[[Category:HardwareInterfacing]]

Serial Commands

2018-06-03T02:39:59Z

Kuroneko:

{| class="wikitable"
!colspan="2"|Commands
|-
!colspan="2"|'''Almost all of these have not been tested for effect'''
|-
!colspan="2"|Piloting
|-
|STOP_MAIN_ENGINE
|Turns off the main engine
|-
|BURN_MAIN_ENGINE
|Turns on the main engine
|-
|TOGGLE_MAIN_ENGINE
|Toggles the state of the main engine
|-
|ENGAGE_COURSE
|Engages the Auto pilot
|-
|FIRE_RCS_CW
|Starts rotating the ship clockwise
|-
|FULL_STOP
|Engages the Auto pilot to stop the ship
|-
|STOP_RCS
|Stops the ships rotation
|-
|FIRE_RCS_CCW
|Starts Rotating the ship counter-clockwise
|-
|UNDOCK
|Undocks the ship
|-
|CANCEL_AUTOPILOT
|Turns off the Auto Pilot
|-
|ROTATE
|-
|PAY_FOR_JUMPGATE
|-
|ACTIVATE_JUMPGATE
|-
|JMP_SPIN_UP_JUMP_DRIVE
|-
|JMP_BEGIN_JUMP
|-
|MAIN_DRIVE_POWER_DECREASE
|-
|MAIN_DRIVE_POWER_INCREASE
|-
!colspan="2"|Nav
|-
|PLOT_COURSE
|plots a course to the cursor on the nav console
|-
|REMOVE_LAST_WAYPOINT
|Removes the last point plotted on a course(maybe?)
|-
|CLEAR_COURSE
|Removes all plotted waypoints
|-
|MAP_MOVE_RIGHT
|rowspan="6"|Moves the map
|-
|MAP_MOVE_LEFT
|-
|MAP_MOVE_DOWN
|-
|MAP_MOVE_UP
|-
|MAP_ZOOM_OUT
|-
|MAP_ZOOM_IN
|-
|MAP_CENTER
|Centers the map on the ship
|-
|TOGGLE_MAP_MODE
|Switches between Cluster and local view
|-
|JMP_CALCULATE_JUMP_SOLUTION
|-
|JMP_SET_JUMP_DESTINATION
|-
!colspan="2"|Weapons
|-
|SELECT_TUBE1
|rowspan="5"|Selects a weapon tube
|-
|SELECT_TUBE2
|-
|SELECT_TUBE3
|-
|SELECT_TUBE4
|-
|SELECT_TUBE5
|-
|DESELECT_TUBE
|Removes weapon tube selection
|-
|SELECT_TUBE
|Selects a weapon tube;
|-
|POWER_DOWN_WEAPON
|Powers down a weapon
|-
|SPIN_UP_WEAPON
|Starts readying a tube to fire
|-
|SET_WEAPON_TARGET
|Sets the Weapon target(Info needs update)
|-
|FIRE_WEAPON
|Fires selected weapon
|-
|ARM_WEAPON
|Prepares a weapon to fire
|-
|UNLINK_WEAPON
|-
|FIRE_CM
|-
|DISABLE_WEAPON
|-
!colspan="2"|Power
|-
|EMCON_OFF
|Turns off EMCOM mode
|-
|EMCON_ON
|Turns on EMCOM mode
|-
|TOGGLE_EMCON
|-
|ENG_DISCONNECT_CURRENT_MODULE
|-
|PWR_TOGGLE_CURRENT_MODULE_EMCON
|-
|SCRAM_REACTOR
|-
|JMP_DISCHARGE_JUMP_DRIVE
|-
|PWR_TOGGLE_CURRENT_MODULE_POWER
|-
|TOGGLE_REACTOR
|-
|POWER_UP_REACTOR
|-
|PWR_CONNECT_HELM
|-
|PWR_DISCONNECT_HELM
|-
|PWR_DISCONNECT_RCS
|-
|PWR_TOGGLE_HELM
|-
|PWR_TOGGLE_RCS
|-
|PWR_CONNECT_RCS
|-
|PWR_CONNECT_MAINDRIVE
|-
|PWR_DISCONNECT_MAINDRIVE
|-
|PWR_DISCONNECT_COMMS
|-
|PWR_TOGGLE_MAINDRIVE
|-
|PWR_TOGGLE_COMMS
|-
|PWR_CONNECT_COMMS
|-
|PWR_CONNECT_WEAP
|-
|PWR_DISCONNECT_WEAP
|-
|PWR_DISCONNECT_JUMPDRIVE
|-
|PWR_TOGGLE_WEAP
|-
|PWR_TOGGLE_JUMPDRIVE
|-
|PWR_CONNECT_JUMPDRIVE
|-
|PWR_CONNECT_BATT1
|-
|PWR_DISCONNECT_BATT1
|-
|PWR_DISCONNECT_BATT2
|-
|PWR_TOGGLE_BATT1
|-
|PWR_TOGGLE_BATT2
|-
|PWR_CONNECT_BATT2
|-
|PWR_CONNECT_BATT3
|-
|PWR_DISCONNECT_BATT3
|-
|PWR_DISCONNECT_NAVCOM
|-
|PWR_TOGGLE_BATT3
|-
|PWR_TOGGLE_NAVCOM
|-
|PWR_CONNECT_NAVCOM
|-
|PWR_CONNECT_SENS
|-
|PWR_DISCONNECT_SENS
|-
|TURN_ON_SHIP
|-
|PWR_TOGGLE_SENS
|-
|TURN_OFF_SHIP
|-
|PWR_SELECT_MODULE
|-
!colspan="2"|Comms
|-
|TURN_OFF_IFF
|-
|TURN_ON_IFF
|-
|COMMUNICATE_WITH_SELECTED
|-
|REQUEST_UNDOCKING_PERMISSION
|-
|REQUEST_DOCKING_PERMISSION
|-
|COMMS_TURN_ON_AUTO
|-
|COMMS_SYNC
|-
|COMMS_TURN_OFF_AUTO
|-
|TURN_OFF_SOS
|-
|TURN_ON_SOS
|-
!Colspan="2"|Sensors
|-
|SENSOR_SELECT_UP
|-
|SENSOR_SELECT_DOWN
|-
|SENSOR_SELECT_LEFT
|-
|SENSOR_SELECT_RIGHT
|-
|SENSOR_SET_NAV_AND_SENSOR_LINKED
|-
|SENSOR_SELECT_TAB
|-
|SENSOR_SET_HISTORY_LOCKED
|-
|SENSOR_UNSET_NAV_AND_SENSOR_LINKED
|-
|SENSOR_SET_AUTO
|-
|SENSOR_UNSET_HISTORY_LOCKED
|-
|SENSOR_UNSET_AUTO
|-
!Colspan="2"|Player movement
|-
|TIME_SLOWER
|-
|TIME_FASTER
|-
|ROOM_RIGHT
|-
|ROOM_LEFT
|-
|LEAVE_SHIP
|-
!Colspan="2"|Mic
|-
|CHANGE_TO_STANDARD_ORBIT
|-
|BREAK_ORBIT
|-
|CHANGE_TO_POLAR_ORBIT
|-
|CHANGE_TO_HIGH_ORBIT
|-
|RESCIND_UNDOCKING_PERMISSION
|-
|RESCIND_DOCKING_PERMISSION
|-
|PAY_DOCKED_STATION
|-
|ENABLE_AUTO_REPAIR
|-
|DISABLE_AUTO_REPAIR
|-
|MAP_CLICK
|-
|ENG_OPEN_CURRENT_MODULE
|-
|ENG_CONNECT_CURRENT_MODULE
|-
|ENG_REPAIR_CURRENT_COMPONENT
|-
|ENG_CLOSE_CURRENT_MODULE
|-
|TELEPORT
|-
|ENG_SELECT_COMPONENT
|-
|ENG_SELECT_MODULE
|-
|ENG_UNMOUNT_COMPONENT
|-
|ENG_MOUNT_COMPONENT
|-
|ENG_TOGGLE_SCREW
|-
|ENG_DESTROY_COMPONENT
|-
|HELM_SET_ATAC_MODE
|not sure what ATAC is
|-
|ENG_TOGGLE_SHIELD
|-
|ENABLE_LADAR
|-
|HELM_UNSET_ATAC_MODE
|-
|TOGGLE_LADAR
|-
|DISABLE_LADAR
|-
|PWR_POWER_DECREASE
|-
|PWR_POWER_INCREASE
|-
|DEACTIVATE_PDS
|-
|ACTIVATE_PDS
|-
|TOGGLE_PDS
|-
|SHIP_CARGO_DOWN
|-
|JETTISON_CARGO
|-
|SHIP_CARGO_UP
|-
|MOORED_CARGO_DOWN
|-
|JETTISON_ALL
|-
|TRANSFER_CARGO_FROM_MOORED
|-
|MOORED_CARGO_UP
|-
|REPAIR_HULL_AT_DEPOT
|-
|TRANSFER_CARGO_FROM_SHIP
|-
|REARM_AT_DEPOT
|-
|REPAIR_MODULES_AT_DEPOT
|-
|TUTORIAL_JUMP
|-
|BUY_CM_AT_DEPOT
|-
|TRADE_PERFORM
|-
|TRADE_TOMAX
|-
|COMMERCE_MENU
|-
|TRADE_CANCEL
|-
|COMMERCE_TAKELOAN
|-
|COMMERCE_GETLICENSE
|-
|COMMERCE_TAKECONTRACT
|-
|COMMERCE_REPAYLOAN
|-
|MECHANIC_TOMENU
|-
|VIEW_WIRE
|-
|MECHANIC_BUY_POD
|-
|MECHANIC_REPAIR
|-
|MECHANIC_UPGRADE_POD
|-
|MECHANIC_SELL_POD
|-
|MECHANIC_MODULETRANSACTION
|-
|MECHANIC_CANCELMODULE
|-
|MECHANIC_SELLARMAMENT
|-
|MECHANIC_BUYARMAMENT
|-
|MOORED_WRECK_UNLOCK_CARGO
|-
|BUY_SHIP
|-
|SET_VIEW_SHIP
|-
|MOORED_WRECK_DOWNLOAD_DATA
|-
|TAKE_PASSENGER
|-
|BOARD_BROKER_SHIP
|-
|PREV_TRACK
|-
|NEXT_TRACK
|-
|RESUME_TRACK
|-
|PAUSE_TRACK
|-
|QUIT_TO_MENU
|-
|TAKE_BOUNTY
|-
|QUIT_TO_OS
|-
|}

[[Category:HardwareInterfacing]]

TipsForDealingWithSerial

2018-06-03T02:34:17Z

Kuroneko: Get the category name right this time...

Some generic tips for dealing with Serial Protocols

== General ==

* Bear in mind the size of your buffers - if your transmit buffer is small, during the "Synchronisation" phase, make sure your tx buffer is empty/has enough space (or your serial library will block until transmission is complete) before sending the next configuration item as most microcontrollers easily run fast enough to outpace 9600bps serial.

* If you get a RX Overrun, your best option with the OIS protocol right now is to discard bytes up until the next CR.

* Because of the format of the messages, you really should check for RX overruns as you read the messages sent by the host - an overrun can very easily change the intent of a message and cause unexpected behaviour, particularly if your channel numbers are similar. (a channel 20 message could be misinterpreted as being channel 2 for example).

== Arduino Specific ==

* Arduino's USB Serial port is implemented in one of two ways depending upon the specific model: Either USB-Serial adapter IC directly connected to USART 0 (most models); or Direct ACM CDC implemented on the AVR itself (Leonardo, some others). With CDC, bit rate commands are a technicality to maintain compatibility with real serial - it has no meaning however (data flows at USB speeds, packet by packet), and with the serial converters, because the converter is wired back to back with the microcontroller, you can safely push the bitrate up. Speeds of 19200-57600 bps should be safely usable as long as you can get the host to agree.

* Don't try to be too generic in your Arduino code - the Arduino library itself is quite inefficient, and you will save a lot of cycles by just doing what you specifically need to do directly, rather than trying to have a degree of runtime configurable behaviour.

* Use pin change interrupts rather than polling the pins for input.

[[Category:HardwareInterfacing]]

TipsForDealingWithSerial

2018-06-03T02:33:48Z

Kuroneko:

Some generic tips for dealing with Serial Protocols

== General ==

* Bear in mind the size of your buffers - if your transmit buffer is small, during the "Synchronisation" phase, make sure your tx buffer is empty/has enough space (or your serial library will block until transmission is complete) before sending the next configuration item as most microcontrollers easily run fast enough to outpace 9600bps serial.

* If you get a RX Overrun, your best option with the OIS protocol right now is to discard bytes up until the next CR.

* Because of the format of the messages, you really should check for RX overruns as you read the messages sent by the host - an overrun can very easily change the intent of a message and cause unexpected behaviour, particularly if your channel numbers are similar. (a channel 20 message could be misinterpreted as being channel 2 for example).

== Arduino Specific ==

* Arduino's USB Serial port is implemented in one of two ways depending upon the specific model: Either USB-Serial adapter IC directly connected to USART 0 (most models); or Direct ACM CDC implemented on the AVR itself (Leonardo, some others). With CDC, bit rate commands are a technicality to maintain compatibility with real serial - it has no meaning however (data flows at USB speeds, packet by packet), and with the serial converters, because the converter is wired back to back with the microcontroller, you can safely push the bitrate up. Speeds of 19200-57600 bps should be safely usable as long as you can get the host to agree.

* Don't try to be too generic in your Arduino code - the Arduino library itself is quite inefficient, and you will save a lot of cycles by just doing what you specifically need to do directly, rather than trying to have a degree of runtime configurable behaviour.

* Use pin change interrupts rather than polling the pins for input.

[[Category:ExternalProtocol]]

TipsForDealingWithSerial

2018-06-03T02:33:23Z

Kuroneko: Created page with "Some generic tips for dealing with Serial Protocols == General == * Bear in mind the size of your buffers - if your transmit buffer is small, during the "Synchronisation" p..."

Some generic tips for dealing with Serial Protocols

== General ==

* Bear in mind the size of your buffers - if your transmit buffer is small, during the "Synchronisation" phase, make sure your tx buffer is empty/has enough space (or your serial library will block until transmission is complete) before sending the next configuration item as most microcontrollers easily run fast enough to outpace 9600bps serial.

* If you get a RX Overrun, your best option with the OIS protocol right now is to discard bytes up until the next CR.

* Because of the format of the messages, you really should check for RX overruns as you read the messages sent by the host - an overrun can very easily change the intent of a message and cause unexpected behaviour, particularly if your channel numbers are similar. (a channel 20 message could be misinterpreted as being channel 2 for example).

== Arduino Specific ==

* Arduino's USB Serial port is implemented in one of two ways depending upon the specific model: Either USB-Serial adapter IC directly connected to USART 0 (most models); or Direct ACM CDC implemented on the AVR itself (Leonardo, some others). With CDC, bit rate commands are a technicality to maintain compatibility with real serial - it has no meaning however (data flows at USB speeds, packet by packet), and with the serial converters, because the converter is wired back to back with the microcontroller, you can safely push the bitrate up. Speeds of 19200-57600 bps should be safely usable as long as you can get the host to agree.

* Don't try to be too generic in your Arduino code - the Arduino library itself is quite inefficient, and you will save a lot of cycles by just doing what you specifically need to do directly, rather than trying to have a degree of runtime configurable behaviour.

* Use pin change interrupts rather than polling the pins for input.

ExternalProtocol

2018-06-03T01:17:30Z

Kuroneko:

ExternalProtocol

2018-06-03T01:13:25Z

Kuroneko: Kuroneko moved page Arduino Controllers to ExternalProtocol: not specific to Arduino

== Arduino Controllers ==

Objects in space was made with the intention that it could be playable with just buttons.<br />
You can also get almost all the information from the in-game UI sent back to your Arduino. <br />
There are 193 Commands [[Serial Commands]], 164 Boolean Requests, and 24 Numeric Requests for a total of 381

== Protocol ==

Currently on the OiS Serial Data Protocol page the Handshake information is incorrect<br />
To connect your Arduino to the game you need to send 451 with a newline at the end. The game will send back 452. source([http://forum.objectsgame.com:88/t/ois-arduino-code-during-beta/911/13 Nocturnal])

[[Category:HardwareInterfacing]]

Arduino Controllers

2018-06-03T01:13:25Z

Kuroneko: Kuroneko moved page Arduino Controllers to ExternalProtocol: not specific to Arduino

#REDIRECT [[ExternalProtocol]]

ExternalProtocol

2018-06-03T01:11:37Z

Kuroneko: Flip to the visible category

Serial Requests

2018-06-03T01:09:22Z

Kuroneko: Add to category

== Numeric Requests ==

{| class="wikitable"
!colspan="2"|Numeric Requests
|-
|POWER_LEVEL
|-
|POWER_DRAIN
|-
|POWER_DRAW_PERCENT
|-
|DESIRED_DIRECTION
|-
|MOTION_ANGLE
|-
|DIRECTION
|-
|CURRENT_SPEED
|-
|CURRENT_SPEED_PERCENT
|-
|PRESSURE_EXTERIOR
|-
|PRESSURE_INTERIOR
|-
|PRESSURE_AIRLOCK
|-
|CURRENT_TEMPERATURE
|-
|CURRENT_DISTANCE
|-
|ASTEROID_DENSITY
|-
|NEBULA_DENSITY
|-
|TUBE_SELECTED
|Which weapon tube is selected
|-
|AMOUNT_OWED_TO_DOCKED
|-
|AMOUNT_OWED_VIA_COMMS
|-
|AUTO_REPAIR_PERCENT
|-
|CURRENT_TUBE_SPIN_UP_PERCENT
|-
|ENG_CURRENT_REPAIR_PERCENT
|-
|ENG_CURRENT_SPARE_PARTS
|-
|ENG_MAX_SPARE_PARTS
|-
|JMP_SOLUTION
|}

== Boolean Requests ==

{| class="wikitable"
!colspan="2"|Boolean Requests
|-
|NAV_TARGET_SELECTED
|-
|IS_MOVING
|-
|MAIN_ENGINE_BURNING
|-
|HAS_SELECTED_DIRECTION
|-
|HAS_COURSE_PLOTTED
|-
|AUTO_PILOT_ENGAGED
|-
|AUTO_PILOT_NOT_ENGAGED
|-
|DOCKED_WITH_JUMPGATE
|-
|HAS_SELECTED_OBJECT
|-
|MAP_LOCKED_TO_SHIP
|-
|MAP_IN_SECTOR_MODE
|-
|PWR_CURRENT_MODULE_ON
|-
|PWR_CURRENT_MODULE_OFF
|-
|PWR_CURRENT_MODULE_EMCON_ON
|-
|PWR_CURRENT_MODULE_EMCON_OFF
|-
|PWR_CURRENT_MODULE_CAN_SCRAM
|-
|PWR_REACTOR_ON
|-
|PWR_REACTOR_OFF
|-
|IS_STATIONARY
|-
|RCS_BURNING
|-
|EMCON_MODE
|-
|HAS_SELECTED_DESTINATION
|-
|STATUS_WARNING
|-
|STATUS_DANGER
|-
|STATUS_NOMINAL
|-
|IN_ASTEROID_FIELD
|-
|IN_NEBULA
|-
|TUBE_HAS_MISSILE
|-
|TUBE_HAS_MINE
|-
|TUBE_HAS_PROBE
|-
|TUBE_CAN_SPIN_UP
|-
|TUBE_CAN_FIRE
|-
|TUBE_CAN_LAUNCH
|-
|TUBE_LAUNCHED
|-
|TUBE_EMPTY
|-
|TUBE_SPINNING_UP
|-
|TUBE_LINKED
|-
|TUBE_HAS_EXP
|-
|TUBE_HAS_EMP
|-
|TARGET_AND_WEAPON_SELECTED
|-
|CAN_ROTATE
|-
|PCE_ALARM
|-
|CLUSTER_MODE
|-
|IS_IN_ORBIT
|-
|IS_IN_STANDARD_ORBIT
|-
|IS_IN_HIGH_ORBIT
|-
|IS_IN_POLAR_ORBIT
|-
|NOT_IN_STANDARD_ORBIT
|-
|NOT_IN_HIGH_ORBIT
|-
|NOT_IN_POLAR_ORBIT
|-
|IS_IN_FREE_SPACE
|-
|IS_CHANGING_ORBIT
|-
|IS_LEAVING_ORBIT
|-
|IS_ENTERING_ORBIT
|-
|IS_CORRECTING_ORBIT
|-
|IS_IN_STABLE_ORBIT
|-
|NOT_DOCKED
|-
|IS_DOCKED_OR_DOCKING
|-
|IS_DOCKED
|-
|IS_DOCKING
|-
|IS_FULLY_DOCKED
|-
|IS_UNDOCKING
|-
|NOT_DOCKING
|-
|NOT_UNDOCKING
|-
|CAN_OPEN_AIRLOCK
|-
|HAS_DOCKING_PERMISSION
|-
|NEEDS_DOCKING_PERMISSION
|-
|HAS_UNDOCKING_PERMISSION
|-
|NEEDS_UNDOCKING_PERMISSION
|-
|ANY_AIRLOCK_OPEN
|-
|ALL_AIRLOCKS_SEALED
|-
|AIRLOCKS_CLOSED_BUT_NEEDS_UNDOCK_PERMISSION
|-
|CAN_UNDOCK
|-
|IFF_ACTIVE
|-
|SELECTED_OBJECT_CAN_COMMUNICATE
|-
|OWES_MONEY_TO_DOCKED_STATION
|-
|IS_DOCKED_WITH_STATION
|-
|IS_DOCKED_WITH_JUMPGATE
|-
|NEED_TO_PAY_FOR_JUMPGATE
|-
|CAN_ACTIVATE_JUMPGATE
|-
|NOT_DOCKED_WITH_STATION
|-
|AUTO_REPAIR_ENABLED
|-
|AUTO_REPAIR_IDLE
|-
|MODULE_REACTOR_UNDAMAGED
|-
|MODULE_REACTOR_DAMAGED
|-
|MODULE_REACTOR_DESTROYED
|-
|MODULE_REACTOR_CONNECTED
|-
|MODULE_REACTOR_FUNCTIONING
|-
|MODULE_MAINDRIVE_UNDAMAGED
|-
|MODULE_MAINDRIVE_DAMAGED
|-
|MODULE_MAINDRIVE_DESTROYED
|-
|MODULE_MAINDRIVE_CONNECTED
|-
|MODULE_RCS_UNDAMAGED
|-
|MODULE_RCS_DAMAGED
|-
|MODULE_RCS_DESTROYED
|-
|MODULE_RCS_CONNECTED
|-
|MODULE_COMMS_UNDAMAGED
|-
|MODULE_COMMS_DAMAGED
|-
|MODULE_COMMS_DESTROYED
|-
|MODULE_COMMS_CONNECTED
|-
|MODULE_BATT1_UNDAMAGED
|-
|MODULE_BATT1_DAMAGED
|-
|MODULE_BATT1_DESTROYED
|-
|MODULE_BATT1_CONNECTED
|-
|MODULE_BATT2_UNDAMAGED
|-
|MODULE_BATT2_DAMAGED
|-
|MODULE_BATT2_DESTROYED
|-
|MODULE_BATT2_CONNECTED
|-
|MODULE_BATT3_UNDAMAGED
|-
|MODULE_BATT3_DAMAGED
|-
|MODULE_BATT3_DESTROYED
|-
|MODULE_BATT3_CONNECTED
|-
|MODULE_HELM_UNDAMAGED
|-
|MODULE_HELM_DAMAGED
|-
|MODULE_HELM_DESTROYED
|-
|MODULE_HELM_CONNECTED
|-
|MODULE_SENSORS_UNDAMAGED
|-
|MODULE_SENSORS_DAMAGED
|-
|MODULE_SENSORS_DESTROYED
|-
|MODULE_SENSORS_CONNECTED
|-
|MODULE_NAVCOM_UNDAMAGED
|-
|MODULE_NAVCOM_DAMAGED
|-
|MODULE_NAVCOM_DESTROYED
|-
|MODULE_NAVCOM_CONNECTED
|-
|MODULE_WEAP_UNDAMAGED
|-
|MODULE_WEAP_DAMAGED
|-
|MODULE_WEAP_DESTROYED
|-
|MODULE_WEAP_CONNECTED
|-
|MODULE_JUMPDRIVE_UNDAMAGED
|-
|MODULE_JUMPDRIVE_DAMAGED
|-
|MODULE_JUMPDRIVE_DESTROYED
|-
|MODULE_JUMPDRIVE_CONNECTED
|-
|SHOW_SPACE_DISC
|-
|DONT_SHOW_SPACE_DISC
|-
|TUBE_1_SELECTED
|-
|TUBE_2_SELECTED
|-
|TUBE_3_SELECTED
|-
|TUBE_4_SELECTED
|-
|TUBE_5_SELECTED
|-
|ENG_MODULE_ON
|-
|ENG_MODULE_OFF
|-
|ENG_MODULE_CAN_OPEN
|-
|ENG_MODULE_OPEN
|-
|ENG_NO_MODULE_OPEN
|-
|ENG_CAN_CLOSE_CURRENT_MODULE
|-
|ENG_MODULE_CAN_BE_CONNECTED
|-
|ENG_NO_TRAY_OBJECT_SELECTED
|-
|ENG_CAN_REPAIR_COMPONENT
|-
|ENG_IS_REPAIRING
|-
|JMP_CAN_SET_JUMP_DESTINATION
|-
|JMP_CAN_SPIN_UP_JUMP_DRIVE
|-
|JMP_CAN_CALC_JUMP
|-
|JMP_CAN_JUMP
|-
|JMP_CAN_DISCHARGE_JUMP_DRIVE
|-
|JMP_HAS_JUMP_DRIVE
|-
|JMP_IS_SPINNING_UP
|-
|JMP_IS_CALCULATING_JUMP
|-
|JMP_IS_SPUN_UP
|-
|JMP_IS_CALCULATED
|-
|PWR_LOW_POWER_WARNING
|-
|PWR_IS_DRAINING
|-
|PWR_IS_GENERATING
|-
|IS_TURNED_ON
|-
|IS_TURNED_OFF
|}

[[Category:HardwareInterfacing]]

Arduino Librarys

2018-06-03T01:08:40Z

Kuroneko:

== Arduino Libraries ==

Simple interface for the serial protocol
[https://github.com/Segwegler/OiS_Library/tree/master/OIS_Web git]

[[Category:HardwareInterfacing]]

Category:HardwareInterfacing

2018-06-03T01:08:17Z

Kuroneko: Created page with "Objects in Space was designed to permit the interfacing of specialised external controllers - a feature that was demonstrated prominently at game shows."

Objects in Space was designed to permit the interfacing of specialised external controllers - a feature that was demonstrated prominently at game shows.

Main Page

2018-06-03T01:06:53Z

Kuroneko: Fix typo

Main Page

2018-06-03T01:06:42Z

Kuroneko: Add Hardware Interfacing category

Wiki in Space:Privacy policy

2018-06-03T00:59:47Z

Kuroneko: Protected "Wiki in Space:Privacy policy": Administrative Information ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

Wiki in Space:Privacy policy

2018-06-03T00:58:51Z

Kuroneko:

Wiki in Space:Privacy policy

2018-06-03T00:52:55Z

Kuroneko: Created page with "== Information that is gathered from visitors == In common with other websites, log files are stored on the web server saving details such as the visitor's IP address, browse..."

Main Page

2018-06-02T09:16:37Z

Kuroneko: First edit to front page