rsudp 1.1.1

https://github.com/raspishake/rsudp

Continuous sudden motion and visual monitoring of Raspberry Shake data

by Ian M. Nesbitt and Richard I. Boaz

Welcome to rsudp’s documentation. This program was written to parse and process live UDP data streams from Raspberry Shake personal seismographs and Raspberry Boom pressure transducer instruments. rsudp allows users the options to see their data in real time, create alert parameters, and be notified in various ways when their instrument detects sudden motion. It is written in Python and is therefore highly customizable.

In order to get a feel for what rsudp can do, check out our YouTube walkthroughs page.

If you prefer to read in-depth documentation, follow our written Tutorial guide.

Or, if you know what you’re looking for, find it in Code documentation.

Tutorial guide

• 1. About rsudp
  • 1.1. Broad overview
  • 1.2. Why it’s special
  • 1.3. What can’t rsudp do?
• 2. Installing rsudp
  • 2.1. Installing on Linux & MacOS
  • 2.2. Installing on Windows
• 3. Modules and Settings
  • 3.1. settings (general settings)
  • 3.2. plot (live data plot)
  • 3.3. alert (STA/LTA earthquake detection trigger)
  • 3.4. RSAM (Real-time Seismic AMplitude)
  • 3.5. alarmsound (play sounds upon alerts)
  • 3.6. telegram (Telegram notification module)
  • 3.7. tweets (Twitter notification module)
  • 3.8. write (miniSEED writer)
  • 3.9. forward (datacast forwarding)
  • 3.10. custom (run custom code)
  • 3.11. printdata (print data to console)
  • 3.12. Default settings
• 4. Running rsudp
  • 4.1. Starting rsudp on Unix
  • 4.2. Starting rsudp on Windows
  • 4.3. Starting manually on Windows or Unix
  • 4.4. Running in demonstration/testing mode
  • 4.5. Quitting
• 5. rsudp as a systemctl daemon
  • 5.1. Setup instructions
  • 5.2. Restarting the daemon
  • 5.3. Troubleshooting the daemon
• 6. Troubleshooting rsudp
  • 6.1. Remote (rsudp) side
  • 6.2. Shake (local) side
  • 6.3. Middle (firewalls)
  • 6.4. Other issues
• 7. Testing and demoing rsudp
  • 7.1. Using the testing functionality
  • 7.2. Settings during testing
  • 7.3. Data flow during testing
  • 7.4. Testing your own modules
  • 7.5. Using your own data

Video resources

• YouTube walkthroughs
• Live demo
• Detected earthquake

Developers' guide

• 1. Program architecture and flow
  • 1.1. Thread layout
  • 1.2. Producer-consumer message passing
  • 1.3. Adding your own consumer modules
  • 1.4. Suggesting features
• 2. Contributing to this project
  • 2.1. Code contributions
  • 2.2. Bugs

Code documentation

The modules available in rsudp are organized by type below.

---

Library

• rsudp.__init__ (initialization functions)
• rsudp.raspberryshake (main library)
• rsudp.helpers (helper functions)
• rsudp.entry_points (convenience fx)

Clients

• rsudp.client (central module)
• rsudp.packetloss (track packets)

Producer and Consumer

• rsudp.p_producer (data producer)
• rsudp.c_consumer (master consumer)

Sub-Consumers

• rsudp.c_alert (STA/LTA alarm)
• rsudp.c_rsam (RSAM analysis)
• rsudp.c_alertsound (play sound)
• rsudp.c_plot (plot data)
• rsudp.c_tweet (Twitter alerts)
• rsudp.c_telegram (Telegram alerts)
• rsudp.c_forward (forward data)
• rsudp.c_write (write data)
• rsudp.c_custom (run code)

Testing modules

• rsudp.t_testdata (test pre-producer)
• rsudp.c_testing (test consumer)
• rsudp.test (test helpers)
• rsudp.packetize (data formatter)

Function index

Need to look something up?

• Index
• Search Page

Back to top ↑