Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document all constants for both user and developer use #44

Open
Susurrus opened this issue Jul 1, 2012 · 7 comments · May be fixed by mavlink/mavlink-devguide#492
Open

Document all constants for both user and developer use #44

Susurrus opened this issue Jul 1, 2012 · 7 comments · May be fixed by mavlink/mavlink-devguide#492

Comments

@Susurrus
Copy link

Susurrus commented Jul 1, 2012

Some of the constants that need documentation are below. Those that are available for the user to edit should also be added to the wiki and possibly the README.

For users:
MAVLINK_USE_CONVENIENCE_FUNCTIONS
MAVLINK_EXTERNAL_RX_BUFFER
MAVLINK_CRC_EXTRA
MAVLINK_ENDIAN
Various constants in protocol.h, mavlink.h

For developers:
MAVLINK_NEED_BYTE_SWAP
MAVLINK_ALIGNED_FIELDS
Various constants in protocol.h, mavlink.h
MAVLINK_MAX_EXTENDED_PAYLOAD_LEN - HW Note, this no longer exists

@amilcarlucas
Copy link
Collaborator

@LorenzMeier he has a good point here

@LorenzMeier
Copy link
Member

Indeed. Let’s get this closed.

@hamishwillee
Copy link
Collaborator

hamishwillee commented May 3, 2019

UPDATED @LorenzMeier Confirmed offline that the following need to be documented (these allow you to configure the library for your needs and e.g. make it more efficient and less standalone).

  • MAVLINK_USE_CONVENIENCE_FUNCTIONS
  • MAVLINK_COMM_NUM_BUFFERS
  • MAVLINK_SIGNING_FLAG_SIGN_OUTGOING
  • MAVLINK_SIGNING_FLAG_NO_TIMESTAMPS
  • MAVLINK_EXTERNAL_RX_STATUS
  • MAVLINK_EXTERNAL_RX_BUFFER
  • NATIVE_BIG_ENDIAN - Set to use MAVLink on a system that is native big-endian (MAVLINK_LITTLE_ENDIAN true by default)
  • MAVLINK_SEPARATE_HELPERS - option to provide alternative implementation of mavlink_helpers.h

The following do not need to be documented - they are internal/not intended to be tuned:

  • MAVLINK_STACK_BUFFER - ? Default is 0
  • MAVLINK_NEED_BYTE_SWAP
  • MAVLINK_MAX_SIGNING_STREAMS
  • MAVLINK_MESSAGE_CRCS
  • MAVLINK_MAX_PAYLOAD_LEN ///< Maximum payload length // it is possible to override this, but be careful! Default 255
  • MAVLINK_SIGNATURE_BLOCK_LEN
  • MAVLINK_MAX_FIELDS 64 //Any benefit to changing number of fields in message
  • Do we need these - don't appear to be used?
    • MAV_MSG_ENTRY_FLAG_HAVE_TARGET_SYSTEM 1
    • MAV_MSG_ENTRY_FLAG_HAVE_TARGET_COMPONENT 2
  • MAVLINK_ALIGNED_FIELDS
  • MAVLINK_CRC_EXTRA - This enables MAVLink 2 checking that message is supported via CRC. Would you ever disable it.
  • MAVLINK_ASSERT

@stale
Copy link

stale bot commented Apr 23, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Apr 23, 2020
@stale
Copy link

stale bot commented Jun 22, 2020

This issue has been automatically marked as stale because it has not had recent activity. Thank you for your contributions.

@stale
Copy link

stale bot commented Aug 22, 2020

This issue has been automatically marked as stale because it has not had recent activity. Thank you for your contributions.

@stale stale bot added the stale label Aug 22, 2020
@stale
Copy link

stale bot commented Oct 23, 2020

This issue has been automatically marked as stale because it has not had recent activity. Thank you for your contributions.

@stale stale bot added the stale label Oct 23, 2020
dakejahl pushed a commit to wattsinnovations/mavlink that referenced this issue Dec 7, 2021
Sync with upstream master | Fri Aug  6 17:06:46 UTC 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants