Text Service
Quick Start
Setup: ED7/ED10
Assuming you have an active text chat license and the authentication settings configured in Display Studio, you can now configure the text chat function.
Settings
Text chat settings can be accessed from the main menu: Functions → Text Chat.
| Setting | Description |
|---|---|
| Enable Text Communications | Globally activate/deactivate text communications |
| Display Name | Enter a name for your session in the chat. e.g. John. Must be unique per vehicle |
| Quick Messages | Quick Messages |
| Message Triggers | Message Triggers |
Once configured, ‘Write’ the config.
Channels
The following channels are available to monitor the status of the system.
| Channel | Description |
|---|---|
| Text Connection Status | The connection status to the text chat server |
| Text Error | The reason for connection failure on error |
| Text Last Message 1-8 | A history of messages received (1 most recent) |
| Text Last Sender 1-8 | A history of message senders (1 most recent) |
Important: The connection status is the status of connection to the text chat server. It doesn’t know if others are connected.
Events
The following events are generated by the chat system.
| Event | When |
|---|---|
| Text Message Received | A text message is received |
| Text Message Sent | A text message is sent |
Setup: EmStream
EmStream stores authentication information per service type rather than in one place for flexibility.
The data service settings can be found in File → Text Chat Settings.
| Setting | Description |
|---|---|
| Host | Enter the host from the below table based on the region configured in the device |
| Display Name | Enter a name for your session in the chat. e.g. John. Must be unique per vehicle |
| Vehicle Name | Exact vehicle name entered during the activation step above |
| Password | The same password entered during the activation step above |
| Use SSL | Must be set to true when using official Emtron servers |
| Region | Host |
|---|---|
| Australia | text-aus.emtronaustralia.com.au |
| North America | text-usa.emtronaustralia.com.au |
Once entered, select Connect to connect to the text server. Once connected you will see Chat Connected in the top right hand corner.
If connection fails, the reason will be shown in the Text Chat Settings popup.
Once connected, you can open the *Chat Console by either clicking the icon in the top right hand corner or from the menu View → Show Chat Console.
Setup: Web Interface (Browser)
Open the chat page in your browser, depending on your region:
| Setting | URL |
|---|---|
| Australia | https://text-aus.emtronaustralia.com.au/chat |
| North America | https://text-usa.emtronaustralia.com.au/chat |
Log in with your credentials
| Setting | Description |
|---|---|
| Your Display Name | Enter a name for your session in the chat. e.g. ‘John’. Must be unique per vehicle |
| Telemetry Vehicle Name | Exact vehicle name entered during the activation step above |
| Telemetry Password | The same password entered during the activation step above |
Once logged in, the chat window opens automatically.
Details
Quick Messages
You can send messages to the chat room based on events occurring.
| Setting | Description |
|---|---|
| Event | When this event occurs, the message will be sent |
| Message | The text at the start of the automated messages. |
| Append Channel Value | The a channel’s value to append to the messages when sending. |
e.g. Set event to Engine Start, message to Engine Started, fuel level, and append channel to Fuel Level.
When the vehicle starts, all connected chat clients will see a message saying the engine has started with the current fuel level.
Message Triggers
You can respond to certain patterns being received. When they are received you can publish a system event.
| Setting | Description |
|---|---|
| Pattern | The pattern you want, e.g. “#next-screen”. |
| Trigger Event | The event you want to publish in the system. e.g. “Next Screen” |
With the above examples, you could change the screen on the Emtron display by sending #next-screen in a connected chat client.