Skip to content

Commit

Permalink
Temp checkin.
Browse files Browse the repository at this point in the history
  • Loading branch information
mfeuer committed Mar 2, 2016
1 parent 73187c1 commit d0bbd83
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 8 deletions.
68 changes: 60 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,74 @@ value, such as 3400.

Signals are organized into a tree such as outlined below.

![Signal tree](https://github.com/PDXostc/vehicle_signal_interface/raw/master/pics/tree.png)
![Signal tree](pics/tree.png)<br>
*Fig 1. A signal tree example*

## SIGNAL TYPE
Each signal specifies a type from the following set (from FrancaIDL):

Name | Type | Min | Max
-----------|----------------------------|------|---
UInt8 | unsigned 8-bit integer |0 | 255
Int8 | signed 8-bit integer | -128 | 127
UInt16 | unsigned 16-bit integer | 0 | 65535
Int16 | signed 16-bit integer | -32768 | 32767
UInt32 | unsigned 32-bit integer | 0 | 4294967295
Int32 | signed 32-bit integer | -2147483648 | 2147483647
UInt64 | unsigned 64-bit integer | 0 | 2^64
Int64 | signed 64-bit integer | -2^63 | 2^63 - 1
Boolean | boolean value | 0/false | 1/true
Float | floating point number | -3.4e -38 | 3.4e 38
Double | double precision floating point number | -1.7e -300 | 1.7e 300
String | character string | n/a | n/a
ByteBuffer | buffer of bytes (aka BLOB) | n/a | n/a

## SIGNAL RANGE [OPTIONAL]
A signal can optionally be specified with a min and max limit,
defining a range that the signal can assume a value within.

## SIGNAL ENUMERATION [OPTIONAL]
A signal can optionally be specified with a set of allowed values that
the signal can take, effectively turning it into an enumerator. The
values are of the same type as the signal itself.

## SIGNAL UNIT TYPE [OPTIONAL]
A signal can optionally specify a unit type from the following set:

Unit type | Domain | Description
-----------|---------------------
kph | Speed | Kilometers per hour
celsius | Temperature | Degrees celsius
mbar | Pressure | millibar
percent | Percent | Percent
hz | frequency | Frequency
lat | position | Decimal latitude
lon | position | Decimal longitude
millimeter | distance | Millimeter
meter | distance | Meter
kilometer | distance | Kilometer
[more to come] ||

## SIGNAL NAMING CONVENTION
Signals are named, left-to-right, from the root of the signal tree
toward the signal itself. Each element in the name is deliniated with
a period (".") .

In Fig 1 above the left mirror heated signal would be:

body.mirrors.left.heated


Signal naming convention

Node vs. tree
What constitutes a signal
Setter vs. Current signals
Interval



# SIGNAL SPECIFICATION FORMAT

## ENTRY

### TYPE
### INTERVAL
### ENUMERATION

## FILE

## INCLUDE DIRECTIVES
Expand Down
Binary file modified pics/tree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions root.vspec
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,16 @@ something.vsi
"description": "0=max forward. 100=max backward"
}

{
"name": "seats.0.massage_level"
"type": {
"type": "Uint16",
"unit_type": "percent",
"enum": [ 1,2,5,6,12]
}
"description": "0=max forward. 100=max backward"
}

{
"name": "seats.driver_seat.position"
"type": {
Expand Down

0 comments on commit d0bbd83

Please sign in to comment.