TCP http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP A multipurpose networking plugin that allows the following and more: * Send and receive messages on TCP sockets. * Host simple web pages and accept [[API]] commands * Allow [[Google Speech]] in Chrome to be used for speech recognition Client http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Client Create a named client, and connect to a server. Write to the server. Receive messages back from the server as events. Connect TCP.Client.Connect 3-6 Name of client to create Address of server to connect to Port of server to connect to Server terminates messages with this byte Generate events with this name when message received from server Only generate events if they match this Regular Expression http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Connect Connects to a server and keeps the connection open, after which messages from the server will generate events. Events will use the client name unless the <EventName> parameter is specified. The message from the server will be attached to the event as a payload. If the server uses a standard terminator at the end of every message (e.g., \x0d) this can be specified in the <Terminator> parameter to ensure that each message generates exactly one event. Disconnect TCP.Client.Disconnect 1 Name of client to disconnect from http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Disconnect Client will disconnect and be destroyed. You can reconnect using the name afterwards. If you only want to send a single command and then disconnect. consider using TCP.Single.Write instead. Query TCP.Client.Query 3-4 Name of client to use Message to send Milliseconds to wait for a response of the server http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Query Query server, similar to TCP.Client.Write. Response will be stored in {LastResult}. ClientName must be the name of a client that was previously created using TCP.Client.Connect To include bytes in the <message>, you can encode bytes as follows 0: \x00 1: \x01 255: \xFF Note: You must first use the Client.Connect action. Write TCP.Client.Write 2-4 Name of client to use Message to send Milliseconds to wait after sending the message (default is 10) http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Write ClientName must be the name of a client that was previously created using TCP.Client.Connect. To include bytes in the <message>, you can encode bytes as follows 0: \x00 1: \x01 255: \xFF Note: You must first use the Client.Connect action. WriteLn TCP.Client.WriteLn 2-4 Milliseconds to wait after sending the message (default is 10) You can write anything here. VC will not use it. http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#WriteLn ClientName must be the name of a client that was previously created using TCP.Client.Connect. To include bytes in the <message>, you can encode bytes as follows 0: \x00 1: \x01 255: \xFF Message will automatically have a carriage return added to it ( \x0D ). GS http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#GS Actions for using Google Speech recognition in a Chrome browser with VoxCommando. Both the "Web Server" AND "Google Speech" must be enabled in the TCP plugin settings to use Google speech recognition in Chrome with VoxCommando. Close TCP.GS.Close 0 http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Close ( BETA ) Attempts to find and close the first Chrome tab that appears to be hosting the speech web page. May not work if there are multiple Chrome windows open. It is probably better to leave the Google speech web page open and turn the microphone on and off using TCP.GS.On and TCP.GS.Off GetLastIP TCP.GS.GetLastIP 0 http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#GetLastIP Returns the IP address of the last client that sent recognnized text to the TCP GS websocket. Launch TCP.GS.Launch 0 http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Launch Attempts to launch the Google Speech web page in Chrome. Both the "Web Server" AND "Google Speech" must be enalbed in the TCP plugin settings to use Google speech recognition in Chrome with VoxCommando. On TCP.GS.On 0 http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#On Sends a message to the web page to attempt to turn the microphone on and start listening for speech. Off TCP.GS.Off 0 http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Off Sends a message to the web page to attempt to turn the microphone off and stop listening for speech. Send TCP.GS.Send 1 Text to send to web page http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Send Send any message to the web page via websocket. (May be useful in later versions of the plugin.) SetLanguage TCP.GS.SetLanguage 1 Example: en-US, fr-FR, de-DE, af-ZA http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#SetLanguage Sets the speech recognition language. Language codes can be found in the TCP settings under the Google Speech tab or possibly there are more codes listed here: https://cloud.google.com/speech-to-text/docs/languages SetPrefix TCP.GS.SetPrefix 0-1 Prefix used to indicate that speech should be sent to VoxCommando http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#SetPrefix If a prefix is used, the webpage will only send recognized text to VoxCommando when the prefix is detected. Any text recognized AFTER the prefix will be sent to VoxCommando for processing. If <Prefix> is blank or omitted the prefix will be removed and ALL text will be accepted. Server http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Server Create TCP servers that can listen for connections, and receive messages. Messages can trigger VC actions or be used to create events. Start TCP.Server.Start 1-2 TCP port to listen on Generate an event instead of sending command to VC http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Start If <GenEvent> parameter is omitted or blank, all incoming client messages will be treated as commands intended for VC. Example: incoming message "VC.On" will turn VC green. If <GenEvent> is specified, then all incoming requests will generate an event and the message from the client will be passed as a payload(s). If <GenEvent> is used, and the message contains '&&' multiple payloads will be created. Stop TCP.Server.Stop 1 Port of server to close http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Stop Stops the server running on <Port>. Server must first have been created using TCP.StartServer. Single http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Single These actions will: -open a new connection -send a string -close the connection immediately Write TCP.Single.Write 3-4 TCP message to send. Encode bytes as \x00\x01...\xFF Default = false. If true will wait for a response from the server http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Write Will send the string <Message> without adding a carriage-return to the IP and port specified in plugin settings. To include bytes in the <message>, you can encode bytes as follows 0: \x00 1: \x01 255: \xFF If Query is set to true then will wait for a response for the server and store it in {LastResult}. WriteLn TCP.Single.WriteLn 3-4 TCP message to send Default = false. If true will wait for a response from the server http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#WriteLn Will send the string <Message> followed by a carriage-return (\x0D) to the IP and port specified in plugin settings. To include bytes in the <Message>, you can encode bytes as follows: 0: \x00 1: \x01 255: \xFF If Query is set to true then will wait for a response for the server and store it in {LastResult}. UDP http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#UDP SendMixed TCP.UDP.SendMixed 2-3 string with hex encoded elements UDP port to send on Defaults to broadcast IP: 255.255.255.255 http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#SendMixed Allows you to send UDP messages to any IP and Port and to embed any ascii or non-ascii characters using the hex format \x00-\xFF. WebServer http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#WebServer SetResponse TCP.WebServer.SetResponse 1 http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#SetResponse Persistent Server http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Persistent Server Write TCP.pSrv.Write 1 http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#Write Send a <message> string to the most recently connected client. WriteLn TCP.pSrv.WriteLn 1 http://voxcommando.com/mediawiki/index.php?title=Plugin_TCP#WriteLn Send a <message> string to the most recently connected client. Append linefeed character at the end.