Telstar Viewdata System

From Telstar Wiki
Jump to navigation Jump to search

987672554-Pages wide.png

Please note TELSTAR 2.0 Alpha is still under development and subject to change.

TELSTAR is both a a videotex application and a videotex service. Details of the current videotex service can be found at https://glasstty.com.

The TELSTAR videotex system, provides a simple viewdata/videotext platform similar to those that were prevalent during the 1980s such as Prestel (https://en.wikipedia.org/wiki/Prestel).

Content for the TELSTAR system is based on simple json files with support for the popular frame editor available at https://edit.tf. As prviously mentioned, frames can also be created programatically through the use of plug-ins.

The videotex implementation described here can be accessed over the internet using modern *internet modems* in conjunction with historic Viewdata and videotex terminals and home computers of the 1980s. In addition the Telstar Viewdata Client can be used with modern computers (MacOS, Linux, Windows).

TELSTAR is is designed to run in a Docker environment and is supplied as a Docker image (see https://hub.docker.com/repository/docker/johnnewcombe/telstar). The system can be installed with a few simple Docker commands or by using Docker Compose. Telstar can also be run under a Kubernetes environment.

The Docker image described here is a full implementation of TELSTAR application, and whilst the system is comprehensive, it is fairly simple to set up. The system can be extended using a very simple plugin architecture and this can be used to add and update content (frames) as required.

Installation

Telstar is implemented using Docker containers and can be managed using Portainer if desired (see Managing Telstar with Portainer). Details of how to install Telstar are detailed in the article Installing Telstar.

Once installed Telstar can be managed using Portainer, see Managing Telstar with Portainer.

2827664245-portainer.png

Pages and Frames

As is typical with interactive videotex systems, pages are numbered from 0 to 999999999 and consist of one or more frames with the suffix a-z, for example the first frame for page 200 would be 200a, the second 200b and so on (see Routing) for more details). These frames are stored within Telstars's database as JSON objects (see https://www.json.org/) and uploaded to Telstar using a simple command line utility.

The Telstar utility program simply interacts with the Telstar API which is a restful API. This can be used directly by any software making it simple to programitically manage pages and routing information.

The simplest frame that can be viewed on TELSTAR would be defined as follows. This would create a simple information frame with some default content.

   {
     "pid": {
       "page-no": 101,
       "frame-id": "a"
     },
     "visible": true,
   }


There are many different frame types that can be defined including basic information frames, response frames that can capture user entered data and gateway frames that allow full duplex connections to other systems. The The Telstar API can be used to all of these frames either using the command line utility or via custom software as required.

Full details of all of the frame types and how to create them is described in the section Frames.

Response Frames and Plugins

Response frames are frames that allow a user to enter data to be processed i.e. a frame where a user enters data such as a form. The data from these frames would typically be processed using an external program or script referred to as a plugin. The plugin can be any software that can be executed e.g. a binary program or a scripts such as Python or Bash etc. All that is required is that the plugin returns a json result, this would typically be a frame or collection of frames.

The Telstar system https://glasstty.com weather page is handled using a response page and plugin. The user is presented with a response frame asking for a town or city. This is passed to an external plugin written in Go (Golang) which accesses the Openweather API and returns the current weather and forcast as a collection of JSON frames. These are captured by Telstar and presented to the user.

Plugins are simple to create and deploy within a Telstar container and can be written in any language supported by the platform.

Further details of the Telstar Plugin framework and how to create them can be found in the section Implementing Plugins.

Adding Frames to the System

Frames can be added to the system using either the Telstar API or by using a plug-in (see Implementing Plugins)

The Telstar API, in conjunction with the cross platform Telstar Util software, provides a simple method of creating and managing pages.

The API can be used to retrieve and update frames and configuring routing. The API is a restful API that uses the GET, PUT, POST and DELETE HTTP methods and as such can be used from any application.

Data is passed to and from the API in JSON format, making the system very simple to use in any programming language. The whole API could be used without any programming at all by using a command line utility such as CURL.

Further details of the Telstar API can be found in the section The Telstar API.

See Also

* Routing
* Frames
* Configuration Options
* Managing Telstar with Portainer
* Orchestrating Telstar with Docker Compose
* Orchestrating Telstar with Kubernetes
* The Telstar API
* Implementing Plugins

Attributions

The website icon is derived from work by Dan Farrimond. This original work and the icon is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported license (https://creativecommons.org/licenses/by-sa/3.0/deed.en).