Chapter 14. Rivendell Macro Langauge

Table of Contents

14.1. Overview
14.2. Protocol
14.3. Command Delivery
14.4. Command Reply
14.5. Specifying Color
14.6. Binary Data
14.7. JACK Port Names
14.8. Log Machines
14.9. Commands
14.9.1. Air Gate [AG]
14.9.2. Append Log [AL]
14.9.3. Binary Serial Out [BO]
14.9.4. Clear Serial Trap [SC]
14.9.5. Command Send [CC]
14.9.6. Connect Jack Ports [JC]
14.9.7. Console Label [CL]
14.9.8. Copy Cut [CP]
14.9.9. Cut Event [CE]
14.9.10. Disconnect Jack Ports [JD]
14.9.11. Disconnect All Jack Ports [JZ]
14.9.12. Duck Panel Button [PD]
14.9.13. Execute Breakaway [DX]
14.9.14. Execute Cart [EX]
14.9.15. Fire Salvo [FS]
14.9.16. GPI Enable [GE]
14.9.17. GPI Enable [GE] (old format, deprecated)
14.9.18. GPI Set [GI]
14.9.19. GPI Set [GI] (old format, deprecated)
14.9.20. GPO Set [GO]
14.9.21. GPO Set [GO] (old format, deprecated)
14.9.22. Insert Cart [PX]
14.9.23. Insert Serial Trap [SI]
14.9.24. Label Panel [PC]
14.9.25. Load Log [LL]
14.9.26. Load Message [LM]
14.9.27. Load Panel [PE]
14.9.28. Load Slot [DL]
14.9.29. Login [LO]
14.9.30. Macro Timer [MT]
14.9.31. Make Next [MN]
14.9.32. Message Box [MB]
14.9.33. No Operation [NN]
14.9.34. Pause Panel [PU]
14.9.35. Play Panel [PP]
14.9.36. Play Slot [DP]
14.9.37. Refresh Log [RL]
14.9.38. Run Shell Command [RN]
14.9.39. Select Widget [PW]
14.9.40. Serial Out [SO]
14.9.41. Serial Reload [SY]
14.9.42. Set Color Label [LC]
14.9.43. Set Default Now & Next Cart [SN]
14.9.44. Set Display [SD]
14.9.45. Set Duck Level [MD]
14.9.46. Set Label [LB]
14.9.47. Set Mode [PM]
14.9.48. Sleep [SP]
14.9.49. Start [PL]
14.9.50. Start Button [PB]
14.9.51. Start Next [PN]
14.9.52. Start Record Deck [RS]
14.9.53. Stop [PS]
14.9.54. Stop Panel [PT]
14.9.55. Stop Record Deck [RR]
14.9.56. Stop Slot [DS]
14.9.57. Switch Add [SA]
14.9.58. Switch Add With Gain [SG]
14.9.59. Switch Crosspoint Gain [SX]
14.9.60. Switch Level [SL]
14.9.61. Switch Reload [SZ]
14.9.62. Switch Remove [SR]
14.9.63. Switch Take [ST]
14.9.64. Toggle On Air Flag [TA]
14.9.65. UDP Out [UO]

14.1. Overview

Rivendell Macro Language (or RML for short) is a set of commands implemented within Rivendell that can be used to program the system to take various actions. A wide variety of commands exist, ranging from control of outboard gear (such as switchers and GPIO devices) to control of various aspects of log playout in RDAirPlay, to Rivendell user management.