{"id":40449839,"url":"https://github.com/pcdshub/ioc-common-generic_streamdevice","last_synced_at":"2026-01-20T17:14:53.635Z","repository":{"id":252311412,"uuid":"830146087","full_name":"pcdshub/ioc-common-generic_streamdevice","owner":"pcdshub","description":null,"archived":false,"fork":false,"pushed_at":"2025-11-04T19:43:45.000Z","size":34,"stargazers_count":0,"open_issues_count":1,"forks_count":5,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-11-04T21:22:05.440Z","etag":null,"topics":["ecs-epics-ioc-common","epics","epics-ioc"],"latest_commit_sha":null,"homepage":null,"language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pcdshub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-07-17T17:24:58.000Z","updated_at":"2025-11-04T19:36:49.000Z","dependencies_parsed_at":"2024-08-09T00:28:06.532Z","dependency_job_id":"d5f5ccd7-924a-4c51-85e3-3e83ce4750b1","html_url":"https://github.com/pcdshub/ioc-common-generic_streamdevice","commit_stats":null,"previous_names":["pcdshub/ioc-common-generic_streamdevice"],"tags_count":2,"template":true,"template_full_name":null,"purl":"pkg:github/pcdshub/ioc-common-generic_streamdevice","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pcdshub%2Fioc-common-generic_streamdevice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pcdshub%2Fioc-common-generic_streamdevice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pcdshub%2Fioc-common-generic_streamdevice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pcdshub%2Fioc-common-generic_streamdevice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pcdshub","download_url":"https://codeload.github.com/pcdshub/ioc-common-generic_streamdevice/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pcdshub%2Fioc-common-generic_streamdevice/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28607625,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T16:10:39.856Z","status":"ssl_error","status_checked_at":"2026-01-20T16:10:39.493Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ecs-epics-ioc-common","epics","epics-ioc"],"created_at":"2026-01-20T17:14:52.954Z","updated_at":"2026-01-20T17:14:53.614Z","avatar_url":"https://github.com/pcdshub.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ioc-common-generic_streamdevice\n\nThis repository provides a **generic StreamDevice IOC** skeleton. It does not control any actual device, but is meant to be copied and customized to implement an IOC communicating with a text-based protocol device over TCP/IP.\n\n---\n## What is a Common IOC?\n\nA **Common IOC** defines a general device type, along with the protocol and methods used to interact with devices of that type. It is not tied to a specific deployed device.\n\n- Use a **Common IOC** to cover all devices of a given type/protocol.\n- Use a **Child IOC** to deploy a specific instance of a device.\n\n\u003e **Note:**  \n\u003e Only create a new Common IOC if the device/protocol you want to use is not already covered by another Common IOC.\n\n\n## Getting Started: Making This Useful\n\nPlease refer to the [IOC Design and Deployment Guide](https://confluence.slac.stanford.edu/spaces/PCDS/pages/92871122/IOC+Design+and+Deployment+Guide) for extensive instructions. The steps here are an abridged version.\n\n\u003e **Note:**  \n\u003e \"gsd\" is just a placeholder. When making your IOC, use a unique and descriptive device name, and update all file names and references accordingly.\n\n## Steps to Customize This IOC\n\n1.  Use this template to create a new repo in pcds devices. After forking this to your own profile, clone this into  `/cds/group/pcds/epics-dev/[username]/ioc/common/[manufacturer]/` during development.\n\n1. **Define Protocol \u0026 Database**\n    - Rename files `app/srcProtocol/gsd.proto` and `app/Db/gsd.db` to match your project/device name.\n    - Edit the protocol file for your device's communication needs. See the [StreamDevice Protocol Guide](https://paulscherrerinstitute.github.io/StreamDevice/) for help in writing the protocol.\n    - For general EPICS records reference see [EPICS record types](https://epics.anl.gov/base/R7-0/4-docs/RecordReference.html).\n\n2. **Autosave**\n    - `app/Db/gsd.req` lists PVs to autosave. Rename and update for your project.\n\n3. **Archiving**\n    - `app/Db/gsd.archive` lists PVs and archive periods. Rename and update.\n\n4. **User Interface (GUI)**\n    - Create a `[gsd]Screens/` folder for your PyDM screens or other GUIs.\n    - Use macro substitutions (e.g., `${prefix}:`) when defining channels.\n    - Update `iocBoot/templates/pydm-ioc.cmd`.\n    - *EDM screens* are deprecated, but you can invoke them with `iocBoot/templates/edm-ioc.cmd` if needed.\n\n5. **Update Makefiles and Scripts**\n    - Change all references from \"gsd\" to your device name.\n    - There are a lot of places you will need to change the name. It is helpful to use a find_and_replace tool for \"gsd\"\n   - Ensure `RELEASE_SITE` and module versions in `config/RELEASE` are current\n\n6. **Create Test/Example Child IOC**\n    - Child IOCs are generally kept in separate \"child\" repositories by deployment area/hutch. However, a test/example child in the `children/` folder is helpful for development.\n    - The child config file holds device-specific info (port number, IP, location, etc.).\n    - The child config filename **must match** the IOC process name in `ioc-manager`.\n    - Create separate config files for each IOC process you run (one process can control multiple devices).\n\n    \u003e **Note:** For a few one-off child IOCs, you can keep them in this folder — but that's not best practice.\n\n---\n\n## Build \u0026 Deployment\n\n### Building\n\nAll compilation and macro expansion uses `make`:\n\n```bash\n# Build both parent and child IOCs (from repo root)\nmake\n\n# Delete all build files\nmake clean\n\n# Clean and build in one step\nmake rebuild\n```\n\n### Running\nThe build creates a launch script for each child in:\n\u003e /children/build/iocBoot/[ioc_name]/st.cmd\n\nYou can run this script directly to start the IOC, but using [IOC Manager](https://confluence.slac.stanford.edu/spaces/PCDS/pages/177176665/IOC+Manager+Staff+Guide) is preferred for ioc process management. Ioc manager will also handle [adding the archive files to the archiver for you](https://confluence.slac.stanford.edu/spaces/timing/pages/433984366/Using+the+Archiver+Scripts+and+Checking+PV+Status).\n\n### Deployment\n\n- Use the `ioc-deploy` script for deployment.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpcdshub%2Fioc-common-generic_streamdevice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpcdshub%2Fioc-common-generic_streamdevice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpcdshub%2Fioc-common-generic_streamdevice/lists"}