TangoPipe

TangoPipe

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 27.11.2019

Instance Members

▸ toTangoHost()

toTangoHost(): TangoHost

Returns

TangoHost:

▸ toTangoDevice()

toTangoDevice(): TangoDevice

Returns

TangoDevice:

▸ read()

read(): Observable<any>

Returns

Observable<any>:

▸ write(v)

write(v: any): Observable<any>

Parameters

v (any)

Returns

Observable<any>:

TangoPipe

new TangoPipe($0: Object, rest: TangoRestApi, id: TangoId)

Extends TangoEntity

Parameters

$0 (Object = {})

Name	Description
$0.rest any
$0.id any

rest (TangoRestApi)

id (TangoId)

Instance Members

▸ toTangoHost()

toTangoHost(): TangoHost

Returns

TangoHost:

▸ toTangoDevice()

toTangoDevice(): TangoDevice

Returns

TangoDevice:

▸ read()

read(): Observable<any>

Returns

Observable<any>:

▸ write(v)

write(v: any): Observable<any>

Parameters

v (any)

Returns

Observable<any>:

TangoRestApi

new TangoRestApi(host: any, options: any)

Parameters

host (any = '')

options (any = {})

Instance Members

▸ toTangoRestApiRequest()

toTangoRestApiRequest(): TangoRestApiRequest

Returns

TangoRestApiRequest:

TangoRestApiRequest

Tango REST API client

new TangoRestApiRequest(url: any, options: any)

Parameters

url (any)

options (any = {})

Properties

url (string)

options (object?) : options

transport (object?) : transport. fetch by default

Instance Members

▸ hosts(host, port)

hosts(host: any, port: any): TangoRestApiRequest

Parameters

host (any)

port (any = 10000)

Returns

TangoRestApiRequest:

▸ devices(name)

devices(name: any): TangoRestApiRequest

Parameters

name (any)

Returns

TangoRestApiRequest:

▸ properties(name)

properties(name: any): TangoRestApiRequest

Parameters

name (any)

Returns

TangoRestApiRequest:

▸ pipes(name)

pipes(name: any): TangoRestApiRequest

Parameters

name (any)

Returns

TangoRestApiRequest:

▸ commands(name)

commands(name: any): TangoRestApiRequest

Parameters

name (any)

Returns

TangoRestApiRequest:

▸ attributes(name)

attributes(name: any): TangoRestApiRequest

Parameters

name (any)

Returns

TangoRestApiRequest:

▸ get(what, options)

get(what: string, options: any): Observable<any>

Parameters

what (string = '') what

options (any = {}) options

Returns

Observable<any>:

▸ post(what, data?, options)

post(what: string, data: any?, options: any): Observable<any>

Parameters

what (string = '') what

data (any?) data

options (any = {})

Returns

Observable<any>:

▸ put(what, data = {}, options)

put(what: string, data: any?, options: any): Observable<any>

Parameters

what (string = '') what

data (any? = {}) data

options (any = {}) options

Returns

Observable<any>:

▸ pipe(what, options)

pipe(what: string, options: any): Observable<any>

Parameters

what (string = '') what

options (any = {})

Returns

Observable<any>:

createConnection

Creates shared Observable that is served as a connection to Subscriptions host

createConnection(host: string, options: {})

Parameters

host (string)

options ({})

Subscriptions

Entry point to TangoRestSubscriptions

new Subscriptions(host: any, options: any)

Parameters

host (any = '')

options (any = {})

Instance Members

▸ subscribe(event)

subscribe(event: any): Subject

Parameters

event (any)

Returns

Subject:

▸ observe($0, host, device, attribute, type)

Start listening for a Tango event host/device/attribute/type

observe($0: Object, host: any, device: any, attribute: any, type: any): Observable

Parameters

$0 (Object)

Name	Description
$0.host any
$0.device any
$0.attribute any
$0.type any

host (any)

device (any)

attribute (any)

type (any)

Returns

Observable:

Subscription

new Subscription($0: Object)

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 3/28/19

Parameters

$0 (Object)

Name	Description
$0.url any
$0.id any
$0.events any
$0.failures any
$0.source any

Instance Members

▸ putTarget(target, options)

putTarget(target: Target, options: {}): Observable<Event>

Parameters

target (Target)

options ({} = {}) options

Returns

Observable<Event>:

EventStream

new EventStream(url: any)

Parameters

url (any)

Instance Members

▸ open()

open(): Observable<EventStream>

Returns

Observable<EventStream>:

▸ stream(id)

stream(id: string): Observable<any>

Parameters

id (string = 'onmessage') Event's id

Returns

Observable<any>:

▸ unsubscribe()

Effectively closes underlying EventSource

unsubscribe()

tango

tango

Static Members

▸ new TangoDevice($0, rest, id, alias)

new TangoDevice($0: Object, rest: TangoRestApi, id: TangoId, alias: string)

Extends TangoEntity

Parameters

$0 (Object)

Name	Description
$0.rest any
$0.id any
$0.alias any (default undefined)

rest (TangoRestApi)

id (TangoId)

alias (string)

Instance Members

▸ toTangoHost()

toTangoHost(): TangoHost

Returns

TangoHost:

kTangoIdSeparator

kTangoIdSeparator

Type: string

TangoId

new TangoId($0: Object)

Author: Igor Khokhriakov <igor.khokhriakov@hzg.de>

Since: 22.10.2019

Parameters

$0 (Object = {})

Name	Description
$0.host any
$0.port any
$0.domain any
$0.family any
$0.device any
$0.name any

Static Members

▸ fromTangoHost(tangoHost)

fromTangoHost(tangoHost: any): TangoId

Parameters

tangoHost (any)

Returns

TangoId:

▸ fromDeviceId(deviceId)

fromDeviceId(deviceId: any): TangoId

Parameters

deviceId (any)

Returns

TangoId:

▸ fromMemberId(memberId)

fromMemberId(memberId: any): TangoId

Parameters

memberId (any)

Returns

TangoId:

Instance Members

▸ setHost(host)

setHost(host: string): TangoId

Parameters

host (string = 'localhost') host

Returns

TangoId:

▸ setPort(port)

setPort(port: (string | int)): TangoId

Parameters

port ((string | int) = 10000) port

Returns

TangoId:

▸ getTangoHostId()

Returns TangoHost id i.e. tango_host:tango_port

getTangoHostId(): string

Returns

string:

▸ setDomain(domain)

setDomain(domain: string): TangoId

Parameters

domain (string)

Returns

TangoId:

▸ setFamily(family)

setFamily(family: string): TangoId

Parameters

family (string)

Returns

TangoId:

▸ setDevice(device)

setDevice(device: string): TangoId

Parameters

device (string)

Returns

TangoId:

▸ getTangoDeviceId()

e.g. localhost:10000/sys/tg_test/1

getTangoDeviceId(): string

Returns

string:

▸ getTangoDeviceName()

e.g. sys/tg_test/1

getTangoDeviceName(): string

Returns

string:

▸ setName(name)

setName(name: string): TangoId

Parameters

name (string)

Returns

TangoId:

▸ getTangoMemberId()

e.g. localhost:10000/sys/tg_test/1/state

getTangoMemberId(): string

Returns

string:

▸ getTangoDeviceFQDN()

e.g. tango://localhost:10000/sys/tg_test/1

getTangoDeviceFQDN(): string

Returns

string:

▸ getTangoMemberFQDN()

e.g. tango://localhost:10000/sys/tg_test/1/state

getTangoMemberFQDN(): string

Returns

string:

▸ toString()

toString(): string

Returns

string:

constructor

constructor(id: TangoId)

Parameters

id (TangoId)

admin

admin(): Observable<TangoAdminDevice>

Returns

Observable<TangoAdminDevice>:

newCommand

newCommand(name: any): TangoCommand

Parameters

name (any)

Returns

TangoCommand:

newAttribute

newAttribute(name: any): TangoAttribute

Parameters

name (any)

Returns

TangoAttribute:

newPipe

newPipe(name: any): TangoPipe

Parameters

name (any)

Returns

TangoPipe:

info

info(): Observable<any>

Returns

Observable<any>:

attributes

attributes(name: any): TangoRestApiRequest

Parameters

name (any = undefined)

Returns

TangoRestApiRequest:

commands

commands(name: any): TangoRestApiRequest

Parameters

name (any = undefined)

Returns

TangoRestApiRequest:

pipes

pipes(name: any): TangoRestApiRequest

Parameters

name (any = undefined)

Returns

TangoRestApiRequest:

properties

properties(name: any): TangoRestApiRequest

Parameters

name (any = undefined)

Returns

TangoRestApiRequest:

eventStream

eventStream(subscriptions: any): Observable<any>

Parameters

subscriptions (any)

Returns

Observable<any>:

toTangoRestApiRequest

toTangoRestApiRequest()

TangoCommand

new TangoCommand($0: Object, rest: TangoRestApi, id: TangoId)

Extends TangoEntity

Parameters

$0 (Object)

Name	Description
$0.rest any
$0.id any

rest (TangoRestApi)

id (TangoId)

Instance Members

▸ toTangoHost()

toTangoHost(): TangoHost

Returns

TangoHost:

▸ toTangoDevice()

toTangoDevice(): TangoDevice

Returns

TangoDevice:

▸ execute(argin)

execute(argin: any): Observable<any>

Parameters

argin (any)

Returns

Observable<any>:

TangoAttribute

new TangoAttribute($0: Object, rest: TangoRestApi, id: TangoId)

Extends TangoEntity

Parameters

$0 (Object)

Name	Description
$0.rest any
$0.id any

rest (TangoRestApi)

id (TangoId)

Instance Members

▸ read(options)

read(options: any): Observable<any>

Parameters

options (any = {})

Returns

Observable<any>:

▸ write(v, options)

write(v: any, options: any): Observable<any>

Parameters

v (any)

options (any)

Returns

Observable<any>:

▸ history()

history(): Observable<any>

Returns

Observable<any>:

▸ eventStream(subscriptions, type)

Opens an event stream for this attribute

eventStream(subscriptions: Subscriptions, type: string): Observable

Parameters

subscriptions (Subscriptions)

type (string = 'change') type

Returns

Observable:

▸ info()

info(): Observable<any>

Returns

Observable<any>:

▸ properties()

properties(): Observable<any>

Returns

Observable<any>:

TangoHost

new TangoHost($0: Object, rest: TangoRestApi, id: TangoId)

Extends TangoEntity

Parameters

$0 (Object)

Name	Description
$0.rest any
$0.id any

rest (TangoRestApi)

id (TangoId)

Instance Members

▸ info()

info(): Observable<Array<string>>

Returns

Observable<Array<string>>:

▸ device(name)

device(name: any): Observable<TangoDevice>

Parameters

name (any)

Returns

Observable<TangoDevice>:

▸ database()

database(): Observable<TangoDatabase>

Returns

Observable<TangoDatabase>:

▸ devices(wildcard)

devices(wildcard: string): Promise<[{name, href}]>

Parameters

wildcard (string)

Returns

Promise<[{name, href}]>:

▸ toTangoRestApiRequest()

toTangoRestApiRequest(): TangoRestApiRequest

Returns

TangoRestApiRequest:

TangoDatabase

new TangoDatabase($0: Object)

Extends TangoDevice

Parameters

$0 (Object)

Name	Description
$0.rest any
$0.id any

Instance Members

▸ deviceAlias(name)

Returns error response if alias is not set - limitation of the native Tango API

deviceAlias(name: any): Observable<string>

Parameters

name (any)

Returns

Observable<string>:

▸ deviceAliasList()

deviceAliasList(): Observable<Array<string>>

Returns

Observable<Array<string>>:

▸ deviceByAlias(alias)

deviceByAlias(alias: any): Observable<string>

Parameters

alias (any)

Returns

Observable<string>:

▸ addDevice(svalue)

addDevice(svalue: any): Observable<any>

Parameters

svalue (any)

Returns

Observable<any>:

▸ deviceDomainList(wildcard)

deviceDomainList(wildcard: any): Observable<any>

Parameters

wildcard (any = "*")

Returns

Observable<any>:

▸ deviceFamilyList(wildcard)

deviceFamilyList(wildcard: any): Observable<any>

Parameters

wildcard (any = "*/*")

Returns

Observable<any>:

▸ deviceMemberList(wildcard)

deviceMemberList(wildcard: any): Observable<any>

Parameters

wildcard (any = "*/*/*")

Returns

Observable<any>:

▸ deviceProperty(args)

deviceProperty(args: []): Observable<any>

Parameters

args ([])

Returns

Observable<any>:

▸ deleteDevice(device)

deleteDevice(device: string): Observable<any>

Parameters

device (string)

Returns

Observable<any>:

▸ putDeviceAlias(device, alias)

putDeviceAlias(device: string, alias: string): Observable<any>

Parameters

device (string)

alias (string)

Returns

Observable<any>:

▸ deleteDeviceAlias(alias)

deleteDeviceAlias(alias: string): Observable<any>

Parameters

alias (string)

Returns

Observable<any>:

addObjPolling

addObjPolling(longStringValue: any): Observable<any>

Parameters

longStringValue (any)

Returns

Observable<any>:

updObjPollingPeriod

updObjPollingPeriod(longStringValue: any): Observable<any>

Parameters

longStringValue (any)

Returns

Observable<any>:

remObjPolling

remObjPolling(args: any): Observable<any>

Parameters

args (any)

Returns

Observable<any>:

updatePolling

updatePolling(device_name: string, pollable: {polling_type: string, name: string, polled: boolean}, polled: boolean, poll_rate: int)

Parameters

device_name (string)

pollable ({polling_type: string, name: string, polled: boolean})

polled (boolean) new polling state

poll_rate (int = 0) new poll rate

getLoggingLevel

getLoggingLevel(args: any): Observable<any>

Parameters

args (any)

Returns

Observable<any>:

getLoggingTarget

getLoggingTarget(arg: string): Observable<any>

Parameters

arg (string) device name

Returns

Observable<any>:

devPollStatus

devPollStatus(device: any): Observable<any>

Parameters

device (any)

Returns

Observable<any>: