Skip to content

Commit 97cbee1

Browse files
committed
docs: add detailed info on parameters and installation process
1 parent b38cdf8 commit 97cbee1

2 files changed

Lines changed: 23 additions & 2 deletions

File tree

KnowledgeBase/topics/EASjs-Generation.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ const header = 'ZCZC-CIV-ADR-020173+0100-3441707-ERN/LB-';
99
generateEASAlert(header)
1010
```
1111

12-
Without any changes to the configuration, it will output the generated SAME alert in the current working directory as
12+
Without any changes to the configuration, it will output the generated alert in the current working directory as
1313
`output.wav`
1414

15-
### Generate an EAS alert with a custom configuration
15+
#### Generate an EAS alert with a custom configuration
1616

1717
```javascript
1818
// Import the MODES object for configuration
@@ -26,3 +26,17 @@ generateEASAlert(header, {
2626
mode: MODES.DIGITAL
2727
})
2828
```
29+
30+
This will output the generated alert as `final-alert.wav` in the current working directory.
31+
32+
#### Custom Parameters for Generation
33+
34+
- `audioPath` - The path to the audio file to use for the alert audio message.
35+
- *EASjs currently supports mp3 and wav files*
36+
- `filename` - The name of the output file
37+
- `format` - The format of the output file (wav or mp3)
38+
- `mode` - The mode of the alert:
39+
- `MODES.DEFAULT` - Style similar to a Digital Alert Systems DASDEC
40+
- `MODES.DIGITAL` - Style similar to a SAGE Digital ENDEC
41+
- `MODES.TRILITHIC` - Style similar to Trilithic EASy ENDECs
42+
- `MODES.NWS` - Similar to `MODES.DEFAULT` but with a 1050 Hz attention tone

KnowledgeBase/topics/EASjs-Installation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,10 @@ You can install the entire EASjs library by running:
66
cd my-project
77
npm install @globaleas/easjs
88
```
9+
10+
You can also include EASjs in your node.js project by adding it into your `package.json` file:
11+
12+
```json
13+
"dependencies": {
14+
"@globaleas/easjs": "^0.2.0"
15+
}

0 commit comments

Comments
 (0)