mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-08-14 17:53:38 +00:00
add language hints to code blocks
This commit is contained in:
@@ -13,7 +13,7 @@ The `db.sqlite` module can open/create SQLite databases
|
||||
|
||||
### Example snippet
|
||||
Opens an in-memory SQLite database
|
||||
```
|
||||
```yaml
|
||||
- id: db
|
||||
type: db.sqlite
|
||||
params:
|
||||
|
||||
@@ -12,7 +12,7 @@ The `http.server` module emits a message for every HTTP request that is made to
|
||||
|
||||
### Example
|
||||
Start an HTTP server listening on port 3000
|
||||
```
|
||||
```yaml
|
||||
- id: httpServer
|
||||
type: http.server
|
||||
params:
|
||||
|
||||
@@ -19,7 +19,7 @@ The `midi.input` module connects to a midi device (or virtual device) and emits
|
||||
|
||||
### Example
|
||||
Open a MIDI connection to `Logic Pro Virtual Out`.
|
||||
```
|
||||
```yaml
|
||||
- id: midiInput
|
||||
type: midi.input
|
||||
params:
|
||||
|
||||
@@ -18,7 +18,7 @@ The `midi.output` module connects to a midi device (or virtual device) and allow
|
||||
|
||||
### Example
|
||||
Open a MIDI connection to `Logic Pro Virtual In`.
|
||||
```
|
||||
```yaml
|
||||
- id: midiOutput
|
||||
type: midi.output
|
||||
params:
|
||||
|
||||
@@ -15,7 +15,7 @@ The `mqtt.client` module connects to a MQTT broker and emits a message messages
|
||||
|
||||
### Example
|
||||
Open a mqtt connection to `test.mosquitto.org` subscribing to the `showbridge` topic.
|
||||
```
|
||||
```yaml
|
||||
- id: mqttClient
|
||||
type: mqtt.client
|
||||
params:
|
||||
|
||||
@@ -12,7 +12,7 @@ This module connects to a [NATS](https://nats.io/) server and subscribes to a su
|
||||
|
||||
### Example
|
||||
Connect to a local NATS server and subscribe to the `events` subject
|
||||
```
|
||||
```yaml
|
||||
- id: natsClient
|
||||
type: nats.client
|
||||
params:
|
||||
|
||||
@@ -12,7 +12,7 @@ This module starts a NATS server that listens for incoming connections.
|
||||
|
||||
### Example
|
||||
Start a local NATS server listening on port 5555
|
||||
```
|
||||
```yaml
|
||||
- id: httpServer
|
||||
type: http.server
|
||||
params:
|
||||
|
||||
@@ -20,7 +20,7 @@ The `net.tcp.client` module connects to TCP server and emits messages based on t
|
||||
|
||||
### Example
|
||||
Open a TCP connection to `127.0.0.1` port 8888, any incoming data will be split on line-feed (`\n`)
|
||||
```
|
||||
```yaml
|
||||
- id: tcpClient
|
||||
type: net.tcp.client
|
||||
params:
|
||||
|
||||
@@ -20,7 +20,7 @@ The `net.tcp.server` module emits a message messages based on the data it receiv
|
||||
|
||||
### Example
|
||||
Start a TCP server listening on port 8888, incoming data will be split on line-feed (`\n`)
|
||||
```
|
||||
```yaml
|
||||
- id: tcpServer
|
||||
type: net.tcp.server
|
||||
params:
|
||||
|
||||
@@ -13,7 +13,7 @@ The `net.udp.client` module sends messages to a the configured `host` and `port`
|
||||
|
||||
### Example
|
||||
setup up a UDP client that will send UDP packets to `127.0.0.1` on port 8888
|
||||
```
|
||||
```yaml
|
||||
- id: udpClient
|
||||
type: net.udp.client
|
||||
params:
|
||||
|
||||
@@ -12,7 +12,7 @@ sidebar:
|
||||
|
||||
### Example
|
||||
Listen to the mDNS multicast address on port 5353
|
||||
```
|
||||
```yaml
|
||||
- id: mdnsListener
|
||||
type: net.udp.multicast
|
||||
params:
|
||||
|
||||
@@ -14,7 +14,7 @@ The `net.udp.server` module emits a message for every incoming UDP datagram.
|
||||
|
||||
### Example
|
||||
Start a UDP server listening on port 8888 and only on `127.0.0.1`
|
||||
```
|
||||
```yaml
|
||||
- id: udpServer
|
||||
type: net.udp.server
|
||||
params:
|
||||
|
||||
@@ -10,8 +10,7 @@ sidebar:
|
||||
This module listens on the [PosiStageNet](http://posistage.net/) multicast address and emits tracker states anytime a new PSN message is received.
|
||||
|
||||
### Example
|
||||
List
|
||||
```
|
||||
```yaml
|
||||
- id: psnClient
|
||||
type: psn.client
|
||||
```
|
||||
@@ -14,7 +14,7 @@ The `redis.client` module connects to a Redis server. This module does not produ
|
||||
|
||||
### Example
|
||||
Connect to a Redis server running on `localhost` at port `6379`.
|
||||
```
|
||||
```yaml
|
||||
- id: redisClient
|
||||
type: redis.client
|
||||
params:
|
||||
|
||||
@@ -26,7 +26,7 @@ The `serial.client` module connects to a serial device and emits a message messa
|
||||
|
||||
### Example
|
||||
Open a serial connection to `/dev/ttyS0` with a buad rate of `115200`, any incoming data will be split on line-feed (`\n`)
|
||||
```
|
||||
```yaml
|
||||
- id: serialClient
|
||||
type: serial.client
|
||||
params:
|
||||
|
||||
@@ -14,7 +14,7 @@ This module starts a [SIP](https://en.wikipedia.org/wiki/Session_Initiation_Prot
|
||||
|
||||
### Example
|
||||
Start a UDP SIP server listening on port 5060
|
||||
```
|
||||
```yaml
|
||||
- id: sipCallServer
|
||||
type: sip.call.server
|
||||
params:
|
||||
|
||||
@@ -16,7 +16,7 @@ This module starts a [SIP](https://en.wikipedia.org/wiki/Session_Initiation_Prot
|
||||
|
||||
### Example
|
||||
Start a UDP SIP server listening on port 5060 that will emit events whenever the user presses the `#` key on their phone during a call
|
||||
```
|
||||
```yaml
|
||||
- id: sipDTMFServer
|
||||
type: sip.dtmf.server
|
||||
params:
|
||||
|
||||
@@ -11,7 +11,7 @@ The `time.interval` module emits a message at a specified duration. Sending any
|
||||
|
||||
### Example snippet
|
||||
Emits a message every 3 seconds
|
||||
```
|
||||
```yaml
|
||||
- id: every3Secs
|
||||
type: time.interval
|
||||
params:
|
||||
|
||||
@@ -11,7 +11,7 @@ The `time.timer` module emits only one message after a specified duration. Sendi
|
||||
|
||||
### Example snippet
|
||||
Emits a message 5 seconds after the module is initialized
|
||||
```
|
||||
```yaml
|
||||
- id: 5secs
|
||||
type: time.timer
|
||||
params:
|
||||
|
||||
Reference in New Issue
Block a user