Skip to content

Update readme - #123

Merged
PastorD merged 3 commits into
masterfrom
pastord_update_readme
Mar 31, 2026
Merged

Update readme#123
PastorD merged 3 commits into
masterfrom
pastord_update_readme

Conversation

@PastorD

@PastorD PastorD commented Mar 20, 2026

Copy link
Copy Markdown
Contributor

Remove outdated content from Readme:

  • add Ubuntu 22.04 and Ubuntu 24.04 to list of supported OSs
  • fix paths to jsd_slaveinfo and jsd_egd_tlc_tty
  • update table to supported devices. It checks for
    • Built in src/CMakeLists.txt
    • In JSD_DRIVER_TYPE_*
    • In config union
    • In state union
    • Has product_code
  • detailed list in device-catalog.md

Details supported table

  • Supported means all of these are true: built in src/CMakeLists.txt, present in JSD_DRIVER_TYPE_*, present in the config union, present in the state union, and implemented with *_product_code_is_compatible(...).
  • README row is grouped where the README uses a family label such as Elmo Platinum Drives or JED (JPL EtherCat Device).
Driver README row Source Private hdr Public hdr Types hdr Built in src/CMakeLists.txt In JSD_DRIVER_TYPE_* In config union In state union Has product_code_is_compatible Supported
ATI_FTS ATI Force-Torque Sensor src/jsd_ati_fts.c src/jsd_ati_fts.h src/jsd_ati_fts_pub.h src/jsd_ati_fts_types.h yes yes yes yes yes yes
EGD Elmo Gold Drives src/jsd_egd.c src/jsd_egd.h src/jsd_egd_pub.h src/jsd_egd_types.h yes yes yes yes yes yes
EL1008 EL1008 src/jsd_el1008.c src/jsd_el1008.h src/jsd_el1008_pub.h src/jsd_el1008_types.h yes yes yes yes yes yes
EL2124 EL2124 src/jsd_el2124.c src/jsd_el2124.h src/jsd_el2124_pub.h src/jsd_el2124_types.h yes yes yes yes yes yes
EL2798 EL2798 src/jsd_el2798.c src/jsd_el2798.h src/jsd_el2798_pub.h src/jsd_el2798_types.h yes yes yes yes yes yes
EL2809 EL2809 src/jsd_el2809.c src/jsd_el2809.h src/jsd_el2809_pub.h src/jsd_el2809_types.h yes yes yes yes yes yes
EL2828 EL2828 src/jsd_el2828.c src/jsd_el2828.h src/jsd_el2828_pub.h src/jsd_el2828_types.h yes yes yes yes yes yes
EL3104 EL3104 src/jsd_el3104.c src/jsd_el3104.h src/jsd_el3104_pub.h src/jsd_el3104_types.h yes yes yes yes yes yes
EL3162 EL3162 src/jsd_el3162.c src/jsd_el3162.h src/jsd_el3162_pub.h src/jsd_el3162_types.h yes yes yes yes yes yes
EL3202 EL3202-0010 src/jsd_el3202.c src/jsd_el3202.h src/jsd_el3202_pub.h src/jsd_el3202_types.h yes yes yes yes yes yes
EL3208 EL3208 src/jsd_el3208.c src/jsd_el3208.h src/jsd_el3208_pub.h src/jsd_el3208_types.h yes yes yes yes yes yes
EL3314 EL3314 src/jsd_el3314.c src/jsd_el3314.h src/jsd_el3314_pub.h src/jsd_el3314_types.h yes yes yes yes yes yes
EL3318 EL3318 src/jsd_el3318.c src/jsd_el3318.h src/jsd_el3318_pub.h src/jsd_el3318_types.h yes yes yes yes yes yes
EL3356 EL3356 src/jsd_el3356.c src/jsd_el3356.h src/jsd_el3356_pub.h src/jsd_el3356_types.h yes yes yes yes yes yes
EL3602 EL3602 src/jsd_el3602.c src/jsd_el3602.h src/jsd_el3602_pub.h src/jsd_el3602_types.h yes yes yes yes yes yes
EL4102 EL4102 src/jsd_el4102.c src/jsd_el4102.h src/jsd_el4102_pub.h src/jsd_el4102_types.h yes yes yes yes yes yes
EL5042 EL5042 src/jsd_el5042.c src/jsd_el5042.h src/jsd_el5042_pub.h src/jsd_el5042_types.h yes yes yes yes yes yes
EPD_NOMINAL Elmo Platinum Drives src/jsd_epd_nominal.c src/jsd_epd_nominal.h src/jsd_epd_nominal_pub.h src/jsd_epd_nominal_types.h yes yes yes yes yes yes
EPD_SIL Elmo Platinum Drives src/jsd_epd_sil.c src/jsd_epd_sil.h src/jsd_epd_sil_pub.h src/jsd_epd_sil_types.h yes yes yes yes yes yes
ILD1900 ILD1900 src/jsd_ild1900.c src/jsd_ild1900.h src/jsd_ild1900_pub.h src/jsd_ild1900_types.h yes yes yes yes yes yes
JED0101 JED (JPL EtherCat Device) src/jsd_jed0101.c src/jsd_jed0101.h src/jsd_jed0101_pub.h src/jsd_jed0101_types.h yes yes yes yes yes yes
JED0200 JED (JPL EtherCat Device) src/jsd_jed0200.c src/jsd_jed0200.h src/jsd_jed0200_pub.h src/jsd_jed0200_types.h yes yes yes yes yes yes

I checked the devices in google but I am not familiar with them, can someone check there are no errors in the device-catalog table?

@dwai-wai @kwehage @JosephBowkett @preston-rogers

@JosephBowkett JosephBowkett left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@PastorD
PastorD merged commit eda2d39 into master Mar 31, 2026
2 checks passed
@PastorD
PastorD deleted the pastord_update_readme branch March 31, 2026 06:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants