ChannelFinder / recsync

EPICS Record Synchronizor
Other
15 stars 25 forks source link

RecSync documentation missing information #87

Open aqshafei opened 7 months ago

aqshafei commented 7 months ago

I'm currently developing a Python implementation of RecCaster to be used alongside p4p, Unfortunately, I've found the documentation a bit unclear or incomplete. Could you please help clarify or provide additional information?

In the existing implementation, the UDP announcement message includes a server address "SERV ADDR". However, it uses the broadcast address and not the actual IP used for TCP connections. RecCaster current implementation checks if "255.255.255.255" is received as "SERV ADDR" then uses the UDP source IP address as "SERV ADDR" instead. Would it possible to update the documentation to provide a clearer explanation Of this behavior?

Would it be possible to expand the documentation to include more detailed information on the "Add Record" and "Add Info" TCP messages?

I am currently unsure about the specific expectations and requirements that RecCeiver has for these messages. While I have able to experiment with various values by reading RecCeiver source code.

These are the following question or additional documentation needed for "Add Record" and "Add Info"

Add Record

Add Info