Skip to content

Commit

Permalink
Merge branch 'main' into script_apis
Browse files Browse the repository at this point in the history
  • Loading branch information
jmthomas committed Jan 27, 2025
2 parents d5e0569 + 8990750 commit 4cf2b76
Show file tree
Hide file tree
Showing 148 changed files with 952 additions and 1,357 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cli.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ jobs:
# spawning a script prints only a PID
./openc3.sh cli script spawn INST/procedures/checks.rb | grep -v "^\s*\d+\s*$"
# run a script that will fail and look for the failure message
./openc3.sh cli script run --wait 10 INST/procedures/checks.rb | tee /dev/tty | grep -q "script failed"
./openc3.sh cli script run --wait 20 INST/procedures/checks.rb | tee /dev/tty | grep -q "script failed"
# run a script that will complete successfully
./openc3.sh cli script run INST/procedures/stash.rb | tee /dev/tty | grep "script complete"
- name: openc3.sh util save,load
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/playwright.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ jobs:
docker ps
docker logs cosmos-openc3-cosmos-init-1
docker logs cosmos-openc3-operator-1
docker logs cosmos-openc3-cosmos-cmd-tlm-api-1
docker logs cosmos-openc3-cosmos-script-runner-api-1
# Build a test plugin for playwright and a copy so we can 'upgrade'
- name: Build plugin
shell: 'script -q -e -c "bash {0}"'
Expand Down
46 changes: 0 additions & 46 deletions compose-dev.yaml

This file was deleted.

5 changes: 4 additions & 1 deletion compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ services:
OPENC3_BUCKET_USERNAME: "${OPENC3_BUCKET_USERNAME}"
OPENC3_BUCKET_PASSWORD: "${OPENC3_BUCKET_PASSWORD}"
OPENC3_SERVICE_PASSWORD: "${OPENC3_SERVICE_PASSWORD}"
ANYCABLE_REDIS_URL: "redis://${OPENC3_REDIS_USERNAME}:${OPENC3_REDIS_PASSWORD}@${OPENC3_REDIS_HOSTNAME}:${OPENC3_REDIS_PORT}"
env_file:
- ".env"

Expand Down Expand Up @@ -147,6 +148,7 @@ services:
OPENC3_SR_BUCKET_USERNAME: "${OPENC3_SR_BUCKET_USERNAME}"
OPENC3_SR_BUCKET_PASSWORD: "${OPENC3_SR_BUCKET_PASSWORD}"
OPENC3_SERVICE_PASSWORD: "${OPENC3_SERVICE_PASSWORD}"
ANYCABLE_REDIS_URL: "redis://${OPENC3_REDIS_USERNAME}:${OPENC3_REDIS_PASSWORD}@${OPENC3_REDIS_HOSTNAME}:${OPENC3_REDIS_PORT}"
env_file:
- ".env"

Expand All @@ -155,7 +157,8 @@ services:
image: "${OPENC3_REGISTRY}/${OPENC3_NAMESPACE}/openc3-operator${OPENC3_IMAGE_SUFFIX}:${OPENC3_TAG}"
restart: "unless-stopped"
# ports:
# - "127.0.0.1:7779:7779" # Open port for the demo router
# - "127.0.0.1:7779:7779" # Open port for the demo router
# - "127.0.0.1:8081:8081/udp" # Open a udp port
depends_on:
- "openc3-redis"
- "openc3-redis-ephemeral"
Expand Down
16 changes: 16 additions & 0 deletions docs.openc3.com/docs/configuration/interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,14 @@ INTERFACE INTERFACE_NAME openc3/interfaces/tcpip_client_interface.py host.docker

The TCPIP server interface creates a TCPIP server which listens for incoming connections and dynamically creates sockets which communicate with the target. This interface is used for targets which open a socket and try to connect to a server.

NOTE: To receive connections from outside the internal docker network you need to expose the TCP port in the compose.yaml file. For example, to allow connections on port 8080 find the openc3-operator section and modify like the following example:

```yaml
openc3-operator:
ports:
- "127.0.0.1:8080:8080" # Open tcp port 8080
```
| Parameter | Description | Required |
| ------------------ | ------------------------------------------------------------------------------------- | -------- |
| Write Port | Port to write commands to (can be the same as read port) | Yes |
Expand Down Expand Up @@ -120,6 +128,14 @@ INTERFACE INTERFACE_NAME openc3/interfaces/tcpip_client_interface.py 8080 8080 1

The UDP interface uses UDP packets to send and receive telemetry from the target.

NOTE: To receive UDP packets from outside the internal docker network you need to expose the UDP port in the compose.yaml file. For example, to allow UDP packets on port 8081 find the openc3-operator section and modify like the following example:

```yaml
openc3-operator:
ports:
- "127.0.0.1:8081:8081/udp" # Open udp port 8081
```
| Parameter | Description | Required | Default |
| ----------------- | ------------------------------------------------------------------------------------------------------------------ | -------- | --------------------------------------------- |
| Host | Host name or IP address of the machine to send and receive data with | Yes |
Expand Down
6 changes: 4 additions & 2 deletions docs.openc3.com/docs/configuration/telemetry-screens.md
Original file line number Diff line number Diff line change
Expand Up @@ -644,6 +644,8 @@ FORMATVALUE INST LATEST TEMP1 %.2f CONVERTED 20
### LABELLED
**Displays a LABEL followed by a LED**

See the LED widget for more information

| Parameter | Description | Required |
|-----------|-------------|----------|
| Target name | The target name | True |
Expand Down Expand Up @@ -786,7 +788,7 @@ LABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120
### LED
**Displays a LED which changes color based on telemetry values**

By default TRUE is green and FALSE is red and all other values are black. Additional values can be added by using the LED_COLOR setting. For example LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN, SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE.
By default TRUE is green and FALSE is red and all other values are black. Additional values can be added by using the LED_COLOR setting. For example LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN, SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE. See LIMITSCOLOR for a widget that displays a circle depicting the limits color of an item.

| Parameter | Description | Required |
|-----------|-------------|----------|
Expand Down Expand Up @@ -856,7 +858,7 @@ LIMITSCOLUMN INST HEALTH_STATUS TEMP1


### LIMITSCOLOR
**Displays a circle depicting the limits color of an item**
**Displays a circle depicting the limits color of an item. See LED for a widget that displays a circle which changes to an arbitrary color based on telemetry values.**

| Parameter | Description | Required |
|-----------|-------------|----------|
Expand Down
Loading

0 comments on commit 4cf2b76

Please sign in to comment.