538
edits
Robonaut: Difference between revisions
From London Hackspace Wiki
replacement-services
(Added some more acnode tools) |
(replacement-services) |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
'''[ | '''[https://github.com/londonhackspace/irccat IRCCat]''' is running on [[Equipment/Blanton#replacement-services|replacement-services]], to help link [[IRC]] to things happening in the space. The documentation below reflects the refreshed instance on [[Equipment/Blanton#replacement-services|replacement-services]]. | ||
== Contributing commands == | |||
During the migration to [[Equipment/Blanton#replacement-services|replacement-services]] we decided to overhaul the command system to make it more flexible and maintainable. We have introduced '''breaking''' changes, so it is important to upgrade your scripts. | |||
=== Persistent commands === | |||
We (the maintainers) of Robonaut maintain a supervised set of persistent commands on [https://github.com/londonhackspace/irccat-commands irccat-commands]. If one wants to add a command to the persistent set of commands, one would need to fork this repository and issue a pull request so we can safeguard the quality of essential and commonly used commands. Each revision will have to go through this process. | |||
=== Contributed commands === | |||
Users can create commands for Robonaut in the <code>/opt/irccat/irccat-commands-contrib</code> directory. No guarantee will be provided on the availability of these commands, and if the system needs to be migrated in the future, we will potentially discard the commands in this folder. This would be a great location for temporary and/or fun commands, or to test your own commands before committing them to the main command set. | |||
=== Write access === | |||
One of the major changes to Robonaut compared to the old instance running on babbage is that write access to the persistent commands directory is prohibited, and that all data should be written to <code>/opt/irccat/irccat-data</code>. While it would also be possible to write to <code>/opt/irccat/irccat-commands-contrib</code>, this would be a very bad idea since this would prevent you from promoting your command to a persistent command. All commands writing outside of the <code>/opt/irccat/irccat-data</code> will be rejected, as well as commands which don't perform proper input filtering and thus offer an opportunity to write outside this directory. | |||
== Robonaut Commands == | == Robonaut Commands == | ||
| Line 19: | Line 25: | ||
=== Really useful commands === | === Really useful commands === | ||
*acnode - Query current usage of a tool and it's status. Current tools are | *acnode - Query current usage of a tool and it's status. Current tools are | ||
** | ** laser - Silvertail A0 lasercutter | ||
** | ** 3in1 - 3 in 1 lathe | ||
** | ** lulzbot - Lulzbot 3d printer | ||
** | ** biolab - BioHacking lab | ||
** | ** tig - Tig welder | ||
*board - Change message on the message board, syntax ?board[ message]. An empty message will clear the board. | *board - Change message on the message board, syntax ?board[ message]. An empty message will clear the board. | ||
| Line 79: | Line 85: | ||
*meter - provides a reading from the power meter [[Electricity meter]]. Useful ones: ?meter UA and ?meter KW | *meter - provides a reading from the power meter [[Electricity meter]]. Useful ones: ?meter UA and ?meter KW | ||
*minilathe - echos the status of the mini lathe. | *minilathe - echos the status of the mini lathe. | ||
*ning - shouts MORNING! or EVENING! depending on | *ning - shouts MORNING! or EVENING! depending on [[Equipment/Landin#Chomsky|Chomsky]]'s time. (also see noon) | ||
*noon - shouts AFTERNOON! | *noon - shouts AFTERNOON! | ||
*notify - displays a message on the board within the space. Will scroll if above 21 characters, and maximum is 162. | *notify - displays a message on the board within the space. Will scroll if above 21 characters, and maximum is 162. | ||
| Line 101: | Line 107: | ||
*time - Gives the date and time rather accurately | *time - Gives the date and time rather accurately | ||
*unwatch | *unwatch | ||
*users - Lists who is logged in to | *users - Lists who is logged in to [[Equipment/Landin#Chomsky|Chomsky]] | ||
*vrms | *vrms | ||
*watch | *watch | ||
| Line 114: | Line 120: | ||
*morning - plays the first few seconds of [http://www.youtube.com/watch?v=PAbwMGZtIsY Edvard Grieg - Morning Mood], and cycles the light through dawny colours, and sets the board to say "Good Morning, hackspace" | *morning - plays the first few seconds of [http://www.youtube.com/watch?v=PAbwMGZtIsY Edvard Grieg - Morning Mood], and cycles the light through dawny colours, and sets the board to say "Good Morning, hackspace" | ||
*patriot - initiates enforced patriotism mode | *patriot - initiates enforced patriotism mode | ||
=== Proposed commands to be implemented soon === | === Proposed commands to be implemented soon === | ||
| Line 119: | Line 126: | ||
*last20 - PMs the most recent 20 chatlines (useful when you've just joined the room) | *last20 - PMs the most recent 20 chatlines (useful when you've just joined the room) | ||
*addquote <quote> - used in PM only, it adds the quote to the wiki list of IRC quotes. | *addquote <quote> - used in PM only, it adds the quote to the wiki list of IRC quotes. | ||
== Administrative Notes == | |||
To start robonaut, from [[Equipment/Landin#Chomsky|Chomsky]] run the following commands: | |||
# /etc/init.d/irccat start | |||
For some bizzaro reason, irccat requires a TCP connection to localhost (and doesn't time out if it can't establish one), so I've also run this: | |||
$ sudo ip6tables -I INPUT 2 -i lo -j ACCEPT | |||
=== Important Paths === | |||
* Data directory: <code>/opt/irccat/irccat-data</code> | |||
* Contributed scripts directory: <code>/opt/irccat/irccat-commands-contrib</code> | |||
* Persistent scripts directory: <code>/opt/irccat/irccat-commands</code> | |||
* IRCcat installation directory: <code>/opt/irccat/irccat-bin</code> | |||
[[Category:Reference]] | [[Category:Reference]] | ||
